-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
170 lines (164 loc) · 4.12 KB
/
swagger.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
# Copyright 2019 The Hyve B.V.
openapi: 3.0.0
info:
version: 0.0.1
title: whereabouts
contact:
name: The Hyve
email: [email protected]
url: https://github.com/thehyve/whereabouts
license:
name: MIT
url: 'https://opensource.org/licenses/MIT'
description: |
Whereabouts API documention.
tags:
- name: Instances
description: Instance related operations
servers:
- url: /
description: Current whereabouts server.
security:
- BearerAuth: []
paths:
/instances:
get:
tags:
- Instances
summary: Get all instances.
description: Requires 'read-instances' user role.
operationId: getInstances
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
instances:
type: array
items:
$ref: '#/components/schemas/Instance'
example:
address: address.example.com
sourceQuery: test query 1
'401':
description: Unauthorized
'403':
description: Forbidden
post:
tags:
- Instances
summary: Adds a new instance with the properties provided in the body.
description: Requires 'create-instances' user role.
operationId: addInstance
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Instance'
example:
id: 1
address: address.example.com
sourceQuery: test query 1
'401':
description: Unauthorized
'403':
description: Forbidden
requestBody:
content:
application/json:
schema:
type: object
properties:
address:
type: string
sourceQuery:
type: string
required: true
'/instances/{id}':
get:
tags:
- Instances
summary: Gets an instance with the given `<id>`.
description: Requires 'read-instances' user role.
operationId: getInstance
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Instance'
example:
id: 1
address: address.example.com
sourceQuery: test query 1
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
put:
tags:
- Instances
summary: Updates the instance with given `<id>` with the values in the body.
description: Requires 'change-instances' user role.
operationId: replaceInstance
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
requestBody:
content:
application/json:
schema:
type: object
properties:
address:
type: string
sourceQuery:
type: string
required: true
components:
schemas:
Instance:
type: object
properties:
id:
description: Unique instance Id
type: number
address:
description: Instance address
type: string
minLength: 1
sourceQuery:
description: Data selection query
type: string
minLength: 1
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT