forked from zircote/swagger-php
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmisc-3.1.0.yaml
179 lines (179 loc) · 4.1 KB
/
misc-3.1.0.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
openapi: 3.1.0
info:
title: 'Testing annotations from bugreports'
description: "NOTE:\nThis sentence is on a new line"
contact:
name: 'Swagger API Team'
license:
name: apache
url: 'https://github.com/zircote/swagger-php/blob/master/LICENSE'
version: 1.0.0
servers:
-
url: '{schema}://host.dev'
description: 'OpenApi parameters'
variables:
schema:
enum:
- https
- http
default: https
paths:
/api/endpoint:
get:
tags:
- endpoints
summary: 'An API endpoint.'
description: 'An endpoint'
operationId: endpoint
parameters:
-
name: filter
in: query
content:
application/json:
schema:
properties:
type: { type: string }
color: { type: string }
type: object
responses:
'200':
$ref: '#/components/responses/200'
security:
-
bearerAuth: []
/api/anotherendpoint:
get:
tags:
- endpoints
summary: 'Another API endpoint.'
description: 'Another endpoint'
operationId: anotherendpoints
parameters:
-
name: 'things[]'
in: query
description: 'A list of things.'
required: false
schema:
type: array
items:
type: integer
responses:
'200':
$ref: '#/components/responses/200'
security:
-
bearerAuth: []
/users:
post:
tags:
- user
summary: 'Adds a new user - with oneOf examples'
description: 'Adds a new user'
operationId: addUser
requestBody:
content:
application/json:
schema:
properties:
id:
type: string
name:
type: string
phone:
oneOf: [{ type: string }, { type: integer }]
type: object
example:
id: a3fb6
name: 'Jessica Smith'
phone: 12345678
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- { $ref: '#/components/schemas/Result' }
- { type: boolean }
examples:
result:
summary: 'An result object.'
value: { success: true }
bool:
summary: 'A boolean value.'
value: false
'/users/{id}':
put:
tags:
- user
summary: 'Updates a user'
description: 'Updates a user'
operationId: updateUser
parameters:
-
name: id
in: path
description: 'Parameter with mutliple examples'
required: true
schema:
type: string
examples:
int:
summary: 'An int value.'
value: '1'
uuid:
summary: 'An UUID value.'
value: 0006faf6-7a61-426c-9034-579f2cfcfa83
responses:
'200':
description: OK
components:
schemas:
Result:
title: 'Sample schema for using references'
properties:
status:
type: string
error:
type: string
type: object
responses:
'200':
description: Success
content:
application/json:
schema:
properties:
name:
description: demo
type: integer
type: object
examples:
'200':
summary: ''
value:
name: 1
'300':
summary: ''
value:
name: 1
'400':
summary: ''
value:
name: 1
securitySchemes:
bearerAuth:
type: http
scheme: bearer
security:
-
bearerAuth: []
tags:
-
name: endpoints
-
name: user
description: user