-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
281 lines (280 loc) · 9.6 KB
/
openapi.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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# Generated with protoc-gen-openapi
# https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi
openapi: 3.0.3
info:
title: User API
version: 0.0.1
paths:
/v1/user:
post:
tags:
- User
operationId: User_CreateUser
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserRequest'
required: true
responses:
"200":
description: OK
content: {}
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/user/{id}:
get:
tags:
- User
operationId: User_GetUser
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: uint32
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
put:
tags:
- User
operationId: User_UpdateUser
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: uint32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserRequest'
required: true
responses:
"200":
description: OK
content: {}
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
delete:
tags:
- User
operationId: User_DeleteUser
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: uint32
responses:
"200":
description: OK
content: {}
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/user/{userId}/order:
post:
tags:
- User
operationId: User_CreateOrderForUser
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: uint32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOrderForUserRequest'
required: true
responses:
"200":
description: OK
content: {}
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/user/{userId}/order/{orderId}:
delete:
tags:
- User
operationId: User_DeleteOrderForUser
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: uint32
- name: orderId
in: path
required: true
schema:
type: integer
format: uint32
responses:
"200":
description: OK
content: {}
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/users:
get:
tags:
- User
operationId: User_ListUsers
parameters:
- name: offset
in: query
schema:
type: integer
format: int64
- name: limit
in: query
schema:
type: integer
format: int64
- name: name
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListUsersResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
components:
schemas:
CreateOrderForUserRequest:
type: object
properties:
userId:
type: integer
format: uint32
orderNo:
type: string
CreateUserRequest:
type: object
properties:
name:
type: string
phone:
type: string
order:
type: array
items:
$ref: '#/components/schemas/OrderItem'
GoogleProtobufAny:
type: object
properties:
'@type':
type: string
description: The type of the serialized message.
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
ListUsersResponse:
type: object
properties:
users:
type: array
items:
$ref: '#/components/schemas/UserResponse'
total:
type: integer
format: int64
OrderItem:
type: object
properties:
orderNo:
type: string
Status:
type: object
properties:
code:
type: integer
description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
format: int32
message:
type: string
description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
details:
type: array
items:
$ref: '#/components/schemas/GoogleProtobufAny'
description: A list of messages that carry the error details. There is a common set of message types for APIs to use.
description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
UpdateUserRequest:
type: object
properties:
id:
type: integer
format: uint32
name:
type: string
phone:
type: string
order:
type: array
items:
$ref: '#/components/schemas/OrderItem'
UserResponse:
type: object
properties:
id:
type: integer
format: uint32
name:
type: string
phone:
type: string
order:
type: array
items:
$ref: '#/components/schemas/OrderItem'
tags:
- name: User