-
Notifications
You must be signed in to change notification settings - Fork 1
/
temperature.newbaseline.raml
241 lines (224 loc) · 8.81 KB
/
temperature.newbaseline.raml
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
#%RAML 0.8
title: OICTemperature
version: v1.1.0-20160519
documentation:
- title: © 2016 Open Connectivity Foundation, Inc. All rights reserved.
content: |
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE Open Connectivity Foundation, INC. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE OR WARRANTIES OF NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL THE Open Connectivity Foundation, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- title: Resource Description
content: |
This resource describes a sensed or actuated Temperature value.
The temperature describes the current value measured.
The units is a single value that is one of C, F or K.
It provides the unit of measurement for the temperature value.
It is a read-only value that is provided by the server.
If the units Property is missing the default is Celsius [C].
The range is an array with min,max values for this temperature on this device.
If no range is provided the default is +/- MAXINT.
schemas:
- Temperature-baseline: !include schemas/oic.r.temperature.newocf.baseline.json
- Temperature-a: !include schemas/oic.r.temperature.a.json
- Temperature-r: !include schemas/oic.r.temperature.r.json
traits:
- interface-a:
queryParameters:
if:
enum: ["oic.if.a"]
- interface-s:
queryParameters:
if:
enum: ["oic.if.s"]
- interface-r:
queryParameters:
if:
enum: ["oic.if.r"]
- interface-baseline:
queryParameters:
if:
enum: ["oic.if.baseline"]
/TemperatureResBaselineURI:
description: |
Baseline properties consist of the standard OCF base resource properties
displayName: Temperature
is: [ interface-baseline ] # baseline interface exposes all properties
get:
description: |
Retrieves the current temperature value.
A client can specify the units for the requested temperature by use of a query parameter.
If no query parameter is provided the server provides its default measure or set value.
responses:
200:
body:
application/json:
schema: Temperature-baseline
example: |
{
"rt": ["oic.r.temperature"],
"if": ["oic.if.a", "oic.if.s", "oic.if.r", "oic.if.baseline"]
}
post:
description: |
Sets the name property "n" to create an annotation
body:
application/json:
schema: Temperature-baseline
example: |
{
"n": "Room Temperature"
}
responses:
200:
body:
application/json:
schema: Temperature-baseline
example: |
{
"rt": ["oic.r.temperature"],
"if": ["oic.if.a", "oic.if.s", "oic.if.r", "oic.if.baseline"],
"n": "Room Temperature"
}
403:
description: |
This response is generated by the OIC Server when the client attempts
to update a read-only property, for example the "if" property
body:
application/json:
schema: Temperature-baseline
example: |
{
"rt": ["oic.r.temperature"],
"if": ["oic.if.a", "oic.if.s", "oic.if.r", "oic.if.baseline"]
}
/TemperatureResSensorURI:
description: |
This resource displays a sensed Temperature value.
displayName: Temperature
is: [ interface-s ] # sensor interface exposes read-only sensed values
get:
description: |
Retrieves the current temperature value.
A client can specify the units for the requested temperature by use of a query parameter.
If no query parameter is provided the server provides its default measure or set value.
queryParameters:
units:
displayName: Units
enum: ["C","F","K"]
responses:
200:
body:
application/json:
schema: Temperature-a
example: |
{
"temperature": 20.0
}
403:
description: |
This response is generated by the OIC Server when the client sends:
A retrieve with q queryParameter indicating a unit that the server does not support.
The server responds with the current resource representation including the
units property illustrating the supported units and the error.
body:
application/json:
schema: Temperature-r
example: |
{
"units": "C",
"range": [0.0,100.0]
}
/TemperatureResActuatorURI:
description: |
This resource describes an actuated Temperature value.
The temperature property displays and accepts the current value.
displayName: Temperature
is: [ interface-a ] # sensor interface exposes actuated values
get:
description: |
Retrieves the current temperature value.
A client can specify the units for the requested temperature by use of a query parameter.
If no query parameter is provided the server provides its default measure or set value.
queryParameters:
units:
displayName: Units
enum: ["C","F","K"]
responses:
200:
body:
application/json:
schema: Temperature-a
example: |
{
"temperature": 20.0
}
403:
description: |
This response is generated by the OIC Server when the client sends:
A retrieve with q queryParameter indicating a unit that the server does not support.
The server responds with the current resource representation including the
units property illustrating the supported units and the error.
body:
application/json:
schema: Temperature-r
example: |
{
"units": "C",
"range": [0.0,100.0]
}
post:
description: |
Sets the desired temperature value, if there is an actuator interface.
If a unit is included and the server does not support the unit indictaed the request will fail.
If the units are omitted value is taken to be in C.
body:
application/json:
schema: Temperature-a
example: |
{
"temperature": 20.0
}
responses:
200:
body:
application/json:
schema: Temperature-a
example: |
{
"temperature": 20.0
}
403:
description: |
This response is generated by the OIC Server when the client sends:
An update with an out of range property value for temperature.
An update with an unsupported unit for this server.
The server responds with the current resource representation including
the range property illustrating the supported range and the error.
body:
application/json:
schema: Temperature-r
example: |
{
"units": "C",
"range": [0.0,100.0]
}
/TemperatureResReadableURI:
description: |
This resource describes a sensed or actuated Temperature value.
THe read-only interface includes the units and range properties
displayName: Temperature
is: [ interface-baseline ] # readable interface exposes configuration properties
get:
description: |
Retrieves the temperature units and range.
responses:
200:
body:
application/json:
schema: Temperature-r
example: |
{
"units": "C",
"range": [0.0,100.0]
}