-
Notifications
You must be signed in to change notification settings - Fork 0
/
open-api.yml
126 lines (126 loc) · 3.13 KB
/
open-api.yml
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
openapi: 3.0.2
info:
description: Example Serverless TODO Application
version: 1.0.0
title: Serverless TODO
paths:
/todo:
post:
summary: Create a new TODO
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Todo'
'500':
description: Something went wrong
requestBody:
description: Create a new TODO
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTodo'
get:
summary: Fetch all TODOs
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Todo'
'500':
description: Something went wrong
'/todo/{id}':
get:
summary: Fetch a TODO
parameters:
- name: id
in: path
description: ID of the TODO
required: true
schema:
type: string
example: "0d24365e-31b0-44dd-a487-3da692a0998d"
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Todo'
'500':
description: Something went wrong
put:
summary: Update a TODO
parameters:
- name: id
in: path
description: ID of the TODO
required: true
schema:
type: string
example: "0d24365e-31b0-44dd-a487-3da692a0998d"
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Todo'
'500':
description: Something went wrong
requestBody:
description: Create a new pet in the store
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SetComplete'
delete:
summary: Delete a TODO
parameters:
- name: id
in: path
description: ID of the TODO
required: true
schema:
type: string
example: "0d24365e-31b0-44dd-a487-3da692a0998d"
responses:
'204':
description: Successful operation
'500':
description: Something went wrong
components:
schemas:
CreateTodo:
properties:
todo:
type: string
example: Clean teeth
type: object
SetComplete:
properties:
complete:
type: boolean
example: true
type: object
Todo:
properties:
completed:
type: boolean
example: false
createdAt:
type: string
example: "2021-09-24T14:16:09.261Z"
todo:
type: string
example: Clean teeth
id:
type: string
example: "0d24365e-31b0-44dd-a487-3da692a0998d"
type: object