-
-
Notifications
You must be signed in to change notification settings - Fork 762
/
swagger.yaml
209 lines (192 loc) · 4.91 KB
/
swagger.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
swagger: "2.0"
info:
title: "{{title}}"
version: "1.0"
basePath: /v1.0
securityDefinitions:
oauth:
type: oauth2
flow: password
tokenUrl: https://oauth.example/token
x-tokenInfoUrl: https://oauth.example/token_info
scopes:
myscope: can do stuff
otherscope: another scope
api_key:
type: apiKey
name: X-Auth
in: header
x-apikeyInfoFunc: fakeapi.hello.apikey_info
jwt:
type: apiKey
name: Authorization
in: header
x-authentication-scheme: Bearer
x-bearerInfoFunc: fakeapi.hello.jwt_info
auth_exception:
type: apiKey
name: X-Api-Key
in: header
x-apikeyInfoFunc: fakeapi.hello.apikey_exception
api_key_query:
type: apiKey
name: apikey
in: query
x-apikeyInfoFunc: fakeapi.hello.apikey_info
paths:
/byesecure/{name}:
get:
summary: Generate goodbye
description: Generates a goodbye message.
operationId: fakeapi.hello.get_bye_secure
security:
- oauth:
- myscope
produces:
- text/plain
responses:
200:
description: goodbye response
schema:
type: string
parameters:
- name: name
in: path
description: Name of the person to say bye.
required: true
type: string
/byesecure-from-flask:
get:
summary: Generate goodbye
description: ""
operationId: fakeapi.hello.get_bye_secure_from_flask
security:
- oauth:
- myscope
produces:
- text/plain
responses:
200:
description: goodbye response
schema:
type: string
/byesecure-from-connexion:
get:
summary: Generate goodbye
description: ""
operationId: fakeapi.hello.get_bye_secure_from_connexion
security:
- oauth:
- myscope
produces:
- text/plain
responses:
200:
description: goodbye response
schema:
type: string
/byesecure-ignoring-context/{name}:
get:
summary: Generate goodbye
description: Generates a goodbye message.
operationId: fakeapi.hello.get_bye_secure_ignoring_context
security:
- oauth:
- myscope
produces:
- text/plain
responses:
200:
description: goodbye response
schema:
type: string
parameters:
- name: name
in: path
description: Name of the person to say bye.
required: true
type: string
/byesecure-jwt/{name}:
get:
summary: Generate goodbye
description: ""
operationId: fakeapi.hello.get_bye_secure_jwt
security:
- jwt: []
produces:
- text/plain
responses:
200:
description: goodbye response
schema:
type: string
parameters:
- name: name
in: path
description: Name of the person to say bye.
required: true
type: string
/more-than-one-security-definition:
get:
summary: Some external call to API
description: External application call
operationId: fakeapi.hello.schema_list
security:
- oauth:
- myscope
- api_key: []
responses:
200:
description: OK
/more-than-one-scope:
get:
summary: Test more than one scope
description: |
Test that connexion handles scopes properly by verifying that user has
all scopes necessary to call the endpoint.
operationId: fakeapi.hello.more_than_one_scope_defined
security:
- oauth:
- myscope
- otherscope
produces:
- text/plain
responses:
200:
description: some response
/optional-auth:
get:
summary: Test empty security definition
description: |
Test that connexion handles an empty security definition correctly.
In case an empty definition is provided, the user is required to
apply proper authentication and authorization techniques.
operationId: fakeapi.hello.optional_auth
security:
- api_key: []
- {}
responses:
'200':
description: some response
/auth-exception:
get:
summary: Test security handler function that raises an exception
description: Throw error from security function
operationId: fakeapi.hello.auth_exception
security:
- auth_exception: []
responses:
'200':
description: some response
/test_apikey_query_parameter_validation:
get:
operationId: fakeapi.hello.test_apikey_query_parameter_validation
parameters:
- name: name
in: query
type: string
security:
- api_key_query: []
responses:
200:
description: OK