This repository has been archived by the owner on Oct 28, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
oas.yaml
181 lines (168 loc) · 4.16 KB
/
oas.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
openapi: 3.0.3
info:
title: Posts API
description: API to interact with Posts Service
version: 1.0.0
servers:
- url: http://localhost:8000/api
description: Local development server
- url: https://mcposts.com/api
description: Main production server
paths:
/posts:
get:
summary: Retrieves list of posts
operationId: postList
parameters:
- in: query
name: limit
required: false
schema:
type: integer
- in: query
name: offset
required: false
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PostOut'
'422':
$ref: '#/components/responses/UnprocessableEntity'
post:
summary: Creates a post
operationId: postCreate
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PostIn'
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PostOut'
'422':
$ref: '#/components/responses/UnprocessableEntity'
/posts/{post_id}:
parameters:
- in: path
name: post_id
required: true
schema:
type: string
format: uuid
get:
summary: Retrieves specific post information
operationId: postGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PostOut'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
put:
summary: Updates specific post information
operationId: postUpdate
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PostUpdate'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PostOut'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
delete:
summary: Deletes specific post
operationId: postDelete
responses:
'204':
description: The resource was deleted successfully
'404':
$ref: '#/components/responses/NotFound'
components:
responses:
NotFound:
description: The specified resource was not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
UnprocessableEntity:
description: The payload contains invalid values
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
properties:
detail:
oneOf:
- type: array
- type: string
required:
- detail
additionalProperties: false
Post:
type: object
properties:
text:
type: string
author:
type: string
additionalProperties: false
PostIn:
allOf:
- $ref: '#/components/schemas/Post'
- type: object
required:
- text
- author
PostOut:
allOf:
- $ref: '#/components/schemas/Post'
- type: object
required:
- id
- text
- author
- created_at
- updated_at
properties:
id:
type: string
format: uuid
created_at:
type: string
format: date-time
updated_at:
type: string
format: datet-time
PostUpdate:
allOf:
- $ref: '#/components/schemas/Post'