Repository navigation
Expand file tree
/
Copy pathswagger.yaml
More file actions
113 lines (113 loc) · 2.43 KB
/
Copy pathswagger.yaml
File metadata and controls
113 lines (113 loc) · 2.43 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
swagger: '2.0'
info:
version: 1.0.0
title: ToDo App
contact:
email: mail@dominikbraun.io
paths:
/todos:
post:
summary: Creates a new ToDo
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/ToDo'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ToDo'
'422':
description: Invalid ToDo structure
get:
summary: Returns a list of all ToDos
responses:
'200':
description: Success
schema:
type: array
items:
$ref: '#/definitions/ToDo'
'/todos/{id}':
get:
summary: Returns a ToDo
parameters:
- name: id
in: path
description: ID of the ToDo
required: true
type: integer
format: int64
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ToDo'
'404':
description: ToDo not found
put:
summary: Overwrites an existing Todo
parameters:
- name: id
in: path
description: ID of the ToDo
required: true
type: integer
format: int64
- in: body
name: body
required: true
schema:
$ref: '#/definitions/ToDo'
responses:
'200':
description: Success
'404':
description: ToDo not found
'422':
description: Invalid ToDo structure
delete:
summary: Deletes a ToDo
parameters:
- name: id
in: path
description: ID of the ToDo
required: true
type: integer
format: int64
responses:
'200':
description: Success
'404':
description: ToDo not found
definitions:
ToDo:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
example: My ToDo
description:
type: string
example: My ToDo Description
tasks:
type: array
items:
$ref: '#/definitions/Task'
Task:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
example: A Task
description:
type: string
example: A Task Description