-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
169 lines (169 loc) · 3.89 KB
/
Copy pathopenapi.yaml
File metadata and controls
169 lines (169 loc) · 3.89 KB
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
openapi: 3.0.3
info:
title: CLI-first Node application
version: 0.1.0
servers:
- url: http://127.0.0.1:3000
paths:
/health:
get:
operationId: Health_Get
tags: [Health]
summary: Check application health
security: []
responses:
"200":
description: Application is healthy
content:
application/json:
schema:
$ref: "#/components/schemas/Health"
/tasks:
get:
operationId: Task_List
tags: [Tasks]
summary: List tasks
security: []
responses:
"200":
description: Tasks
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Task"
post:
operationId: Task_Create
tags: [Tasks]
summary: Create a task
security: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateTask"
responses:
"201":
description: Task created
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
"400":
description: Invalid request body
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/tasks/{id}:
parameters:
- name: id
in: path
required: true
schema:
type: string
get:
operationId: Task_Get
tags: [Tasks]
summary: Get a task
security: []
responses:
"200":
description: Task
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
"404":
description: Task not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
patch:
operationId: Task_Update
tags: [Tasks]
summary: Update a task
security: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateTask"
responses:
"200":
description: Task updated
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
"404":
description: Task not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"400":
description: Invalid request body
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
delete:
operationId: Task_Delete
tags: [Tasks]
summary: Delete a task
security: []
responses:
"204":
description: Task deleted
"404":
description: Task not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
components:
schemas:
Health:
type: object
required: [status]
properties:
status:
type: string
example: ok
Task:
type: object
required: [id, title, completed]
properties:
id:
type: string
title:
type: string
completed:
type: boolean
CreateTask:
type: object
required: [title]
properties:
title:
type: string
minLength: 1
UpdateTask:
type: object
minProperties: 1
properties:
title:
type: string
minLength: 1
completed:
type: boolean
Error:
type: object
required: [error]
properties:
error:
type: string