-
Notifications
You must be signed in to change notification settings - Fork 215
/
properties.yml
333 lines (325 loc) · 13.2 KB
/
properties.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
# 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: List all properties of a feature
description: |-
Returns all properties of the feature identified by the `thingId` and `featureId` path parameter.
tags:
- Features
parameters:
- $ref: '../../parameters/thingIdPathParam.yml'
- $ref: '../../parameters/featureIdPathPathParam.yml'
- $ref: '../../parameters/propertiesFieldsQueryParam.yml'
- $ref: '../../parameters/ifMatchHeaderParamHash.yml'
- $ref: '../../parameters/ifNoneMatchHeaderParam.yml'
- $ref: '../../parameters/getMetadataParam.yml'
- $ref: '../../parameters/timeoutParam.yml'
- $ref: '../../parameters/conditionParam.yml'
- $ref: '../../parameters/channelParam.yml'
- $ref: '../../parameters/liveChannelConditionParam.yml'
- $ref: '../../parameters/liveChannelTimeoutStrategyParam.yml'
responses:
'200':
description: The properties were successfully retrieved.
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/features/featureProperties.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 specified feature has no properties or
the thing with the specified `thingId` or the feature with `featureId` was not found.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'412':
$ref: '../../responses/preconditionFailed.yml'
put:
summary: Create or update all properties of a feature at once
description: |-
Create or update the properties of a feature identified by the `thingId` and `featureId` path parameter.
The properties will be overwritten with the JSON content from the request body.
tags:
- Features
parameters:
- $ref: '../../parameters/thingIdPathParam.yml'
- $ref: '../../parameters/featureIdPathPathParam.yml'
- $ref: '../../parameters/ifMatchHeaderParamHash.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 properties were 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
content:
application/json:
schema:
$ref: '../../schemas/features/featureProperties.yml'
'204':
description: The properties were successfully updated.
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 feature properties to be created/modified 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'
'403':
description: |-
The request could not be completed. Possible reasons:
* the caller has insufficient permissions.
For modifying the properties of an existing feature, `WRITE` permission is required.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'404':
description: |-
The request could not be completed. The thing or the feature with the given ID was not found.
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/features/featureProperties.yml'
example: {
"configuration": {
"smartMode": true,
"brewingTemp": 87,
"tempToHold": 44,
"timeoutSeconds": 6000
},
"status": {
"waterAmount": 731,
"temperature": 44
}
}
description: |-
JSON object of all properties to be updated at once.
Consider that the value has to be a JSON object or `null`. We strongly recommend to use
a restricted set of characters for the key (identifier).
Currently these identifiers should follow the pattern: [_a-zA-Z][_a-zA-Z0-9\-]*
required: true
patch:
summary: Patch all properties of a feature
description: |-
Patch the properties of a feature identified by the `thingId` and `featureId` path parameter.
The existing properties will be merged with the JSON content set in the request body.
Notice that the `null` value can be used to delete specific feature properties.
For further documentation see [RFC 7396](https://tools.ietf.org/html/rfc7396).
**Note**: In contrast to the "PUT things/{thingId}/features/{featureId}/properties" request,
a partial update is supported here and request body is merged with the existing properties.
tags:
- Features
parameters:
- $ref: '../../parameters/thingIdPathParam.yml'
- $ref: '../../parameters/featureIdPathPathParam.yml'
- $ref: '../../parameters/ifMatchHeaderParamHash.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 properties were 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 `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 feature properties to be created/modified 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'
'403':
description: |-
The request could not be completed. Possible reasons:
* the caller has insufficient permissions.
For modifying the properties of an existing feature, `WRITE` permission is required.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'404':
description: |-
The request could not be completed. The thing or the feature with the given ID was not found.
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/features/featureProperties.yml'
example:
configuration:
smartMode: null
brewingTemp: 87
tempToHold: 44
timeoutSeconds: 6000
status:
waterAmount: 731
temperature: 44
description: |-
JSON object of all properties to be patched.
Consider that the value has to be a [JSON merge patch](https://tools.ietf.org/html/rfc7396).
We strongly recommend to use a restricted set of characters for the key (identifier).
Currently these identifiers should follow the pattern: [_a-zA-Z][_a-zA-Z0-9\-]*
required: true
delete:
summary: Delete all properties of a feature
description: |-
Deletes all properties of the feature identified by the `thingId` and `featureId` path parameter.
tags:
- Features
parameters:
- $ref: '../../parameters/thingIdPathParam.yml'
- $ref: '../../parameters/featureIdPathPathParam.yml'
- $ref: '../../parameters/ifMatchHeaderParamHash.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 properties were 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 has insufficient permissions.
For deleting the properties of an existing feature, `WRITE` permission is required.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'404':
description: |-
The request could not be completed. The specified feature has no properties or
the thing with the specified `thingId` or the feature with `featureId` was not found.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'412':
$ref: '../../responses/preconditionFailed.yml'
'424':
$ref: '../../responses/dependencyFailed.yml'