-
Notifications
You must be signed in to change notification settings - Fork 215
/
thing.yml
539 lines (507 loc) · 19.6 KB
/
thing.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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
# Copyright (c) 2020 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License 2.0 which is available at
# http://www.eclipse.org/legal/epl-2.0
#
# SPDX-License-Identifier: EPL-2.0
get:
summary: Retrieve a specific thing
description: |-
Returns the thing identified by the `thingId` path parameter. The response includes details about the thing,
including the `policyId`, attributes, definition and features.
Optionally, you can use the field selectors (see parameter `fields`) to only get specific fields,
which you are interested in.
### Example:
Use the field selector `_policy` to retrieve the content of the policy.
tags:
- Things
parameters:
- $ref: '../../parameters/thingIdPathParam.yml'
- $ref: '../../parameters/thingFieldsQueryParam.yml'
- $ref: '../../parameters/ifMatchHeaderParam.yml'
- $ref: '../../parameters/ifNoneMatchHeaderParam.yml'
- $ref: '../../parameters/getMetadataParam.yml'
- $ref: '../../parameters/timeoutParam.yml'
- $ref: '../../parameters/conditionParam.yml'
- $ref: '../../parameters/channelParamPutDescription.yml'
- $ref: '../../parameters/liveChannelConditionParam.yml'
- $ref: '../../parameters/liveChannelTimeoutStrategyParam.yml'
responses:
'200':
description: The request successfully returned the specific thing.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
live-channel-condition-matched:
description: |-
Whether or not the live-channel-condition did match and the thing was retrieved from the device.
schema:
type: boolean
channel:
description: |-
The cannel which was used to retrieve the thing.
schema:
type: string
content:
application/json:
schema:
$ref: '../../schemas/things/thing.yml'
application/td+json:
schema:
$ref: '../../schemas/wot-thingDescription.yml'
'304':
$ref: '../../responses/notModified.yml'
'400':
description: |-
The request could not be completed. Possible reasons:
* the `thingId` does not conform to the namespaced entity ID notation (see [Ditto documentation on namespaced entity IDs](https://websites.eclipseprojects.io/ditto/basic-namespaces-and-names.html#namespaced-id))
* at least one of the defined query parameters is invalid
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'404':
description: |-
The request could not be completed. The thing with the given ID was not found.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'412':
$ref: '../../responses/preconditionFailed.yml'
put:
summary: Create or update a thing with a specified ID
description: |-
Create or update the thing specified by the `thingId` path parameter and the optional JSON body.
* If you set a new `thingId` in the path, a thing will be created.
* If you set an existing `thingId` in the path, the thing will be updated.
### Create a new thing
At the initial creation of a thing, only a valid `thingId` is required.
However, you can create a full-fledged thing all at once.
### Example:
To create a coffee maker thing, set the `thingId` in the path, e.g. to "com.acme.coffeemaker:BE-42"
and the body part, like in the following snippet.
```
{
"definition": "com.acme:coffeebrewer:0.1.0",
"attributes": {
"manufacturer": "ACME demo corp.",
"location": "Berlin, main floor",
"serialno": "42",
"model": "Speaking coffee machine"
},
"features": {
"coffee-brewer": {
"definition": [ "com.acme:coffeebrewer:0.1.0" ],
"properties": {
"brewed-coffees": 0
}
},
"water-tank": {
"properties": {
"configuration": {
"smartMode": true,
"brewingTemp": 87,
"tempToHold": 44,
"timeoutSeconds": 6000
},
"status": {
"waterAmount": 731,
"temperature": 44
}
}
}
}
}
```
As the example does not set a policy in the request body, but the thing concept requires one,
the service will create a default policy. The default policy, has the exactly same id
as the thing, and grants ALL permissions to the authorized subject.
In case you need to associate the new thing to an already existing policy you can additionally
set a policy e.g. "policyId": "com.acme.coffeemaker:policy-1" as the first element in the body part.
Keep in mind, that you can also change the assignment to another policy anytime,
with a request on the sub-resource "PUT /things/{thingId}/policyId"
The field `_created` is filled automatically with the timestamp of the creation. The field is read-only and can
be retrieved later by explicitly selecting it or used in search filters.
### Update an existing thing
For updating an existing thing, the authorized subject needs **WRITE** permission on the thing's root resource.
The ID of a thing cannot be changed after creation. Any `thingId`
specified in the request body is therefore ignored.
tags:
- Things
parameters:
- $ref: '../../parameters/thingIdPathParam.yml'
- $ref: '../../parameters/ifMatchHeaderParam.yml'
- $ref: '../../parameters/ifNoneMatchHeaderParam.yml'
- $ref: '../../parameters/putMetadataParam.yml'
- $ref: '../../parameters/deleteMetadataParam.yml'
- $ref: '../../parameters/requestedAcksParam.yml'
- $ref: '../../parameters/timeoutParam.yml'
- $ref: '../../parameters/responseRequiredParam.yml'
- $ref: '../../parameters/conditionParam.yml'
- $ref: '../../parameters/channelParam.yml'
responses:
'201':
description: The thing was successfully created.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
Location:
description: The location of the created thing resource
schema:
type: string
content:
application/json:
schema:
$ref: '../../schemas/things/thing.yml'
'204':
description: The thing was successfully modified.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
'400':
description: |-
The request could not be completed. Possible reasons:
* the `thingId` does not conform to the namespaced entity ID notation (see [Ditto documentation on namespaced entity IDs](https://websites.eclipseprojects.io/ditto/basic-namespaces-and-names.html#namespaced-id))
* the JSON body of the thing to be created/modified is invalid
* the JSON body of the thing to be created/modified contains a `thingId`
which does not match the ID in the path
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'403':
description: |-
The request could not be completed. Possible reasons:
* the caller would not have access to the thing after creating it with the given policy
* the caller has insufficient permissions.
For modifying an existing thing, an unrestricted `WRITE` permission on the thing's root resource is required.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'404':
description: |-
The request could not be completed. Possible reasons:
* the referenced thing does not exist.
* the caller has insufficient permissions to read the referenced thing.
* the policy that should be copied does not exist.
* the caller has insufficient permissions to read the policy that should be copied.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'412':
$ref: '../../responses/preconditionFailed.yml'
'413':
$ref: '../../responses/entityTooLarge.yml'
'424':
$ref: '../../responses/dependencyFailed.yml'
requestBody:
content:
application/json:
schema:
$ref: '../../schemas/things/newThing.yml'
example: {
"definition": "com.acme:coffeebrewer:0.1.0",
"attributes": {
"manufacturer": "ACME demo corp.",
"location": "Berlin, main floor",
"serialno": "42",
"model": "Speaking coffee machine"
},
"features": {
"coffee-brewer": {
"definition": [ "com.acme:coffeebrewer:0.1.0" ],
"properties": {
"brewed-coffees": 0
}
},
"water-tank": {
"properties": {
"configuration": {
"smartMode": true,
"brewingTemp": 87,
"tempToHold": 44,
"timeoutSeconds": 6000
},
"status": {
"waterAmount": 731,
"temperature": 44
}
}
}
}
}
description: JSON representation of the thing to be modified.
patch:
summary: Patch a thing with a specified ID
description: |-
Patch an existing thing specified by the `thingId` path parameter.
Patching a thing will merge the provided request body with the exisiting thing.
This makes it possible to change only some parts of a thing in single request without providing the full thing
structure in the request body.
### Patch a thing
With this resource it is possible to add, update or delete parts of an existing thing.
The request body provided in *JSON merge patch* (RFC-7396) format will be merged with the existing thing.
Notice that the `null` value in the JSON body will delete the specified JSON key from the thing.
For further documentation of JSON merge patch see [RFC 7396](https://tools.ietf.org/html/rfc7396).
### Example
A Thing already exists with the following content:
```
{
"definition": "com.acme:coffeebrewer:0.1.0",
"attributes": {
"manufacturer": "ACME demo corp.",
"location": "Berlin, main floor",
"serialno": "42",
"model": "Speaking coffee machine"
},
"features": {
"coffee-brewer": {
"definition": ["com.acme:coffeebrewer:0.1.0"],
"properties": {
"brewed-coffees": 0
}
},
"water-tank": {
"properties": {
"configuration": {
"smartMode": true,
"brewingTemp": 87,
"tempToHold": 44,
"timeoutSeconds": 6000
},
"status": {
"waterAmount": 731,
"temperature": 44
}
}
}
}
}
```
To make changes that only affect parts of the existing thing, e.g. add some attribute and delete a
specific feature property, the content of the request body could look like this:
```
{
"attributes": {
"manufacturingYear": "2020"
},
"features": {
"water-tank": {
"properties": {
"configuration": {
"smartMode": null,
"tempToHold": 50,
}
}
}
}
}
```
The request body will be merged with the existing thing and the result will be the following thing:
```
{
"definition": "com.acme:coffeebrewer:0.1.0",
"attributes": {
"manufacturer": "ACME demo corp.",
"manufacturingYear": "2020",
"location": "Berlin, main floor",
"serialno": "42",
"model": "Speaking coffee machine"
},
"features": {
"coffee-brewer": {
"definition": ["com.acme:coffeebrewer:0.1.0"],
"properties": {
"brewed-coffees": 0
}
},
"water-tank": {
"properties": {
"configuration": {
"brewingTemp": 87,
"tempToHold": 50,
"timeoutSeconds": 6000
},
"status": {
"waterAmount": 731,
"temperature": 44
}
}
}
}
}
```
### Permissions for patching an existing Thing
For updating an existing thing, the authorized subject needs **WRITE** permission on those parts of the thing
that are affected by the merge update.
For example, to successfully execute the above example the authorized subject needs to have unrestricted
*WRITE* permissions on all affected paths of the JSON merge patch: `attributes/manufacturingYear`,
`features/water-tank/properties/configuration/smartMode`,
`features/water-tank/properties/configuration/tempToHold`. The *WRITE* permission must not be revoked on any
level further down the hierarchy. Consequently it is also sufficient for the authorized subject to have
unrestricted *WRITE* permission at root level or unrestricted *WRITE* permission at `/attributes` and
`/features` etc.
tags:
- Things
parameters:
- $ref: '../../parameters/thingIdPathParam.yml'
- $ref: '../../parameters/ifMatchHeaderParam.yml'
- $ref: '../../parameters/ifNoneMatchHeaderParam.yml'
- $ref: '../../parameters/putMetadataParam.yml'
- $ref: '../../parameters/deleteMetadataParam.yml'
- $ref: '../../parameters/requestedAcksParam.yml'
- $ref: '../../parameters/timeoutParam.yml'
- $ref: '../../parameters/responseRequiredParam.yml'
- $ref: '../../parameters/conditionParam.yml'
- $ref: '../../parameters/channelParam.yml'
responses:
'204':
description: The thing was successfully patched.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
'400':
description: |-
The request could not be completed. Possible reasons:
* the JSON body of the thing to be patched is invalid
* the JSON body of the thing to be patched contains a `thingId` which does not match the ID in the path
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'403':
description: |-
The request could not be completed. Possible reasons:
* the caller would not have access to the thing after creating it with the given policy
* the caller has insufficient permissions.
For modifying an existing thing, an unrestricted `WRITE` permission on the thing's root resource is required.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'404':
description: |-
The request could not be completed. Possible reasons:
* the referenced thing does not exist.
* the caller has insufficient permissions to read the referenced thing.
* the policy that should be copied does not exist.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'412':
$ref: '../../responses/preconditionFailed.yml'
'413':
$ref: '../../responses/entityTooLarge.yml'
'424':
$ref: '../../responses/dependencyFailed.yml'
requestBody:
content:
application/merge-patch+json:
schema:
$ref: '../../schemas/things/patchThing.yml'
example:
attributes:
manufacturingYear: '2020'
features:
water-tank:
properties:
configuration:
smartMode: null
tempToHold: 50
description: JSON representation of the thing to be patched.
delete:
summary: Delete a specific thing
description: |-
Deletes the thing identified by the `thingId` path parameter.
This will not delete the policy, which is used for controlling access to this thing.
You can delete the policy afterwards via DELETE `/policies/{policyId}` if you don't need it for other things.
tags:
- Things
parameters:
- $ref: '../../parameters/thingIdPathParam.yml'
- $ref: '../../parameters/ifMatchHeaderParam.yml'
- $ref: '../../parameters/ifNoneMatchHeaderParam.yml'
- $ref: '../../parameters/requestedAcksParam.yml'
- $ref: '../../parameters/timeoutParam.yml'
- $ref: '../../parameters/responseRequiredParam.yml'
- $ref: '../../parameters/conditionParam.yml'
- $ref: '../../parameters/channelParam.yml'
responses:
'204':
description: The thing was successfully deleted.
'400':
description: |-
The request could not be completed. Possible reasons:
* the `thingId` does not conform to the namespaced entity ID notation (see [Ditto documentation on namespaced entity IDs](https://websites.eclipseprojects.io/ditto/basic-namespaces-and-names.html#namespaced-id)).
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'403':
description: |-
The request could not be completed. Possible reasons:
* the caller had insufficient permissions.
For deleting an existing thing, an unrestricted `WRITE` permission on the thing's root resource is required.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'404':
description: |-
The request could not be completed. The thing with the given ID was not found.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'412':
$ref: '../../responses/preconditionFailed.yml'
'424':
$ref: '../../responses/dependencyFailed.yml'