This repository has been archived by the owner on Apr 4, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
/
openapi-spec.yml
441 lines (433 loc) · 12.9 KB
/
openapi-spec.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
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
openapi: 3.0.0
#servers:
# - url: http://localhost:8081
info:
version: "1.0.0-beta.18"
title: LinkSmart Thing Directory
description: API documetnation of the [LinkSmart Thing Directory](https://github.com/linksmart/thing-directory)
license:
name: Apache 2.0
url: https://github.com/linksmart/thing-directory/blob/master/LICENSE
tags:
- name: td
description: Thing Directory API
- name: validation
description: Validation API
paths:
/td:
get:
tags:
- td
summary: Retrieves paginated list of Thing Descriptions
description: The query languages, described [here](https://github.com/linksmart/thing-directory/wiki/Query-Language), can be used to filter results and fetch parts of Thing Descriptions.
parameters:
- $ref: '#/components/parameters/ParamPage'
- $ref: '#/components/parameters/ParamPerPage'
- name: jsonpath
in: query
description: JSONPath expression for fetching specific items. E.g. `$[?(@.title=='Kitchen Lamp')].properties`
required: false
schema:
type: string
# example: $[?(@.title=='Kitchen Lamp')].properties
- name: xpath
in: query
description: xPath 3.0 expression for fetching specific items. E.g. `//*[title='Kitchen Lamp']/properties`
required: false
schema:
type: string
# example: //*[title='Kitchen Lamp']/properties
responses:
'200':
description: Successful response
content:
application/ld+json:
schema:
$ref: '#/components/schemas/ThingDescriptionPage'
examples:
ThingDescriptionList:
$ref: '#/components/examples/ThingDescriptionList'
'400':
$ref: '#/components/responses/RespBadRequest'
'401':
$ref: '#/components/responses/RespUnauthorized'
'403':
$ref: '#/components/responses/RespForbidden'
'500':
$ref: '#/components/responses/RespInternalServerError'
/td/:
post:
tags:
- td
summary: Creates new Thing Description with system-generated ID
description: |
This is to create a TD and receive a unique system-generated `id` in response.<br>
The server rejects the request if there is an `id` in the body.<br>
For creating a TD with user-defined `id`, use the `PUT` method.
responses:
'201':
description: Created successfully
headers:
Location:
description: Path to the newly created Thing Description
schema:
type: string
'400':
$ref: '#/components/responses/RespBadRequest'
'401':
$ref: '#/components/responses/RespUnauthorized'
'403':
$ref: '#/components/responses/RespForbidden'
'500':
$ref: '#/components/responses/RespInternalServerError'
requestBody:
content:
application/ld+json:
schema:
type: object
examples:
ThingDescription:
$ref: '#/components/examples/ThingDescriptionWithoutID'
description: Thing Description to be created
required: true
/td/{id}:
put:
tags:
- td
summary: Creates a new Thing Description with the provided ID, or updates an existing one
description: |
The `id` in the path is the resource id and must match the one in Thing Description.<br>
For creating a TD without user-defined `id`, use the `POST` method.
parameters:
- name: id
in: path
description: ID of the Thing Description
example: "urn:example:1234"
required: true
schema:
type: string
responses:
'200':
description: Thing Description updated successfully
'201':
description: A new Thing Description is created
'400':
$ref: '#/components/responses/RespBadRequest'
'401':
$ref: '#/components/responses/RespUnauthorized'
'403':
$ref: '#/components/responses/RespForbidden'
'409':
$ref: '#/components/responses/RespConflict'
'500':
$ref: '#/components/responses/RespInternalServerError'
requestBody:
content:
application/ld+json:
schema:
type: object
examples:
ThingDescription:
$ref: '#/components/examples/ThingDescriptionWithID'
description: The Thing Description object
required: true
patch:
tags:
- td
summary: Patch a Thing Description
description: The patch document must be based on RFC7396 JSON Merge Patch
parameters:
- name: id
in: path
description: ID of the Thing Description
example: "urn:example:1234"
required: true
schema:
type: string
responses:
'200':
description: Thing Description patched successfully
'400':
$ref: '#/components/responses/RespBadRequest'
'401':
$ref: '#/components/responses/RespUnauthorized'
'403':
$ref: '#/components/responses/RespForbidden'
'409':
$ref: '#/components/responses/RespConflict'
'500':
$ref: '#/components/responses/RespInternalServerError'
requestBody:
content:
application/merge-patch+json:
schema:
type: object
examples:
ThingDescription:
$ref: '#/components/examples/ThingDescriptionWithID'
description: The Thing Description object
required: true
get:
tags:
- td
summary: Retrieves a Thing Description
parameters:
- name: id
in: path
description: ID of the Thing Description
example: "urn:example:1234"
required: true
schema:
type: string
responses:
'200':
description: Successful response
content:
application/ld+json:
schema:
type: object
examples:
response:
$ref: '#/components/examples/ThingDescriptionWithID'
'400':
$ref: '#/components/responses/RespBadRequest'
'401':
$ref: '#/components/responses/RespUnauthorized'
'403':
$ref: '#/components/responses/RespForbidden'
'404':
$ref: '#/components/responses/RespNotfound'
'500':
$ref: '#/components/responses/RespInternalServerError'
delete:
tags:
- td
summary: Deletes the Thing Description
parameters:
- name: id
in: path
description: ID of the Thing Description
required: true
schema:
type: string
responses:
'200':
description: Successful response
'401':
$ref: '#/components/responses/RespUnauthorized'
'403':
$ref: '#/components/responses/RespForbidden'
'404':
$ref: '#/components/responses/RespNotfound'
'500':
$ref: '#/components/responses/RespInternalServerError'
/validation:
get:
tags:
- validation
summary: Retrieves the validation result for a given Thing Description
description: |
The Thing Description should be provided as JSON in the request body.<br>
Note: This is currently not supported using Swagger UI.
responses:
'200':
description: Validation Result
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResult'
'400':
$ref: '#/components/responses/RespBadRequest'
'401':
$ref: '#/components/responses/RespUnauthorized'
'403':
$ref: '#/components/responses/RespForbidden'
'500':
$ref: '#/components/responses/RespInternalServerError'
# wait for openapi 3.1.0 which brings back support for requetsBody in GET
# requestBody:
# content:
# application/ld+json:
# schema:
# type: object
# examples:
# ThingDescription:
# $ref: '#/components/examples/ThingDescription'
security:
- BasicAuth: []
- BearerAuth: []
components:
parameters:
ParamPage:
name: page
in: query
description: Page number in the pagination
required: false
schema:
type: number
format: integer
ParamPerPage:
name: per_page
in: query
description: Number of entries per page
required: false
schema:
type: number
format: integer
securitySchemes:
BasicAuth:
type: http
scheme: basic
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
responses:
RespBadRequest:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
RespUnauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
RespForbidden:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
RespNotfound:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
RespConflict:
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
RespInternalServerError:
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
schemas:
ErrorResponse:
type: object
properties:
code:
type: integer
message:
type: string
ThingDescription:
description: WoT Thing Description
type: object
ThingDescriptionPage:
type: object
properties:
'@context':
format: url
'@type':
format: string
items:
type: array
items:
$ref: '#/components/schemas/ThingDescription'
page:
type: integer
perPage:
type: integer
total:
type: integer
ValidationResult:
type: object
properties:
valid:
type: boolean
errors:
type: array
items:
type: string
examples:
ThingDescriptionWithoutID:
summary: Example Thing Description
value:
{
"@context": "https://www.w3.org/2019/wot/td/v1",
"title": "ExampleSensor",
"properties": {
"status": {
"forms": [
{
"op": ["readproperty"],
"href": "https://example.com/status",
"contentType": "text/html"
}
]
}
},
"security": ["nosec_sc"],
"securityDefinitions": {"nosec_sc":{"scheme":"nosec"}
}
}
ThingDescriptionWithID:
summary: Example Thing Description
value:
{
"@context": "https://www.w3.org/2019/wot/td/v1",
"id": "urn:example:1234",
"title": "ExampleSensor",
"properties": {
"status": {
"forms": [
{
"op": ["readproperty"],
"href": "https://example.com/status",
"contentType": "text/html"
}
]
}
},
"security": ["nosec_sc"],
"securityDefinitions": {"nosec_sc":{"scheme":"nosec"}
}
}
ThingDescriptionList:
summary: Example Paginated Thing Descriptions
value:
{
"@context": "https://linksmart.eu/thing-directory/context.jsonld",
"@type": "Catalog",
"items":[
{
"@context": "https://www.w3.org/2019/wot/td/v1",
"id": "urn:example:1234",
"title": "ExampleSensor",
"properties": {
"status": {
"forms": [
{
"op": ["readproperty"],
"href": "https://example.com/status",
"contentType": "text/html"
}
]
}
},
"security": ["nosec_sc"],
"securityDefinitions": {"nosec_sc":{"scheme":"nosec"}
}
}
],
"page": 1,
"perPage": 100,
"total": 1
}