Skip to content

Commit 1d8e4b9

Browse files
authored
Merge pull request #110 from OAI/darrelmiller-patch-1
Update security.md
2 parents 07545df + 2f05cd4 commit 1d8e4b9

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

specification/security.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ info:
5555
and requesting the state of the board or of individual squares.
5656
version: 1.0.0
5757
security:
58-
defaultApiKey: []
58+
- defaultApiKey: []
5959
paths:
6060
/board:
6161
get:
6262
security:
63-
defaultApiKey: []
63+
- defaultApiKey: []
6464
```
6565
6666
This method of referencing Security Scheme objects is valid for all types. The array shown as the value of `defaultApiKey` above is populated for OAuth Flow and OpenID Connect objects, which have some additional features that are discussed below. An empty array is provided in all other cases.
@@ -139,14 +139,14 @@ info:
139139
and requesting the state of the board or of individual squares.
140140
version: 1.0.0
141141
security:
142-
oauth2Profiles:
142+
- oauth2Profiles:
143143
- board:read
144144
- board:write
145145
paths:
146146
/board:
147147
get:
148148
security:
149-
oauth2Profiles: []
149+
- oauth2Profiles: []
150150
```
151151

152152
Note that if you want to segregate grant types - where, for example, Client Credentials is only supported for a specific Operation - you'll need to create a separate Security Scheme object that can be applied individually. This is also true if you want to differentiate the available scopes, for example:
@@ -185,15 +185,15 @@ paths:
185185
/board:
186186
get:
187187
security:
188-
app2AppOauth:
189-
- board:read
188+
- app2AppOauth:
189+
- board:read
190190
...
191191
/board/{row}/{column}:
192192
put:
193193
security:
194-
user2AppOauth:
195-
- board:read
196-
- board:write
194+
- user2AppOauth:
195+
- board:read
196+
- board:write
197197
...
198198
```
199199

@@ -226,7 +226,7 @@ info:
226226
and requesting the state of the board or of individual squares.
227227
version: 1.0.0
228228
security:
229-
openIdConnect:
229+
- openIdConnect:
230230
- board:read
231231
- board:write
232232
```

0 commit comments

Comments
 (0)