-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapispec.yaml
140 lines (140 loc) · 3.61 KB
/
apispec.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
openapi: 3.0.3
info:
description: API for managing Notes.
version: 0.0.1
title: Notes API
servers:
- url: SERVER_URL
security:
- ApiKeyAuth: []
paths:
/notes:
get:
summary: List 'Notes' objects.
description: Retrieve a page of 'Note' objects from the server.
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: object
properties:
Notes:
type: array
items:
$ref: '#/components/schemas/ListOfNotes'
post:
summary: Creates a new 'Note' object.
description: Creates a new 'Note' object.
requestBody:
description: The Note object to create.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
responses:
"201":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
/notes/{id}:
get:
summary: Retrieve Note object.
description: Retrieve a single Note object.
parameters:
- name: id
in: path
required: true
description: Unique identifier of the desired Note object.
schema:
type: string
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
"404":
description: Note was not found.
put:
summary: Update Note object.
description: Update a single Note object.
parameters:
- name: id
in: path
required: true
description: Unique identifier of the desired Note object.
schema:
type: string
requestBody:
description: The Note object to update.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
"404":
description: Note was not found.
delete:
summary: Delete Note object.
description: Delete a single Note object.
parameters:
- name: id
in: path
required: true
description: Unique identifier of the desired Note object.
schema:
type: string
responses:
"200":
description: Successful response
"404":
description: Note was not found.
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
name: x-apikey
in: header
schemas:
Note:
title: Note
type: object
properties:
id:
description: The id of the Note
type: string
example: hu32hu3
name:
description: The name of the Note
type: string
example: New note
text:
description: The text of the Note
type: string
example: This is a note
location:
description: The lopcation of the Note
type: string
example: Berlin, Germany
likes:
description: How many likes the Note has
type: number
example: 7
ListOfNotes:
title: List of Note objects
type: array
items:
$ref: '#/components/schemas/Note'