-
Notifications
You must be signed in to change notification settings - Fork 2
/
oic.wk.rd.swagger.json
executable file
·276 lines (276 loc) · 10.4 KB
/
oic.wk.rd.swagger.json
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
{
"swagger": "2.0",
"info": {
"title": "Resource directory resource",
"version": "2019-02-22",
"license": {
"name": "OCF Data Model License",
"url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
"x-copyright": "Copyright 2016-2019 Open Connectivity Foundation, Inc. All rights reserved."
},
"termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md"
},
"schemes": ["http"],
"consumes": ["application/json"],
"produces": ["application/json"],
"paths": {
"/oic/rd" : {
"get": {
"description": "Resource to be exposed by any Device that can act as a Resource Directory.\n1) Provides selector criteria (e.g., integer) with GET request\n2) Publish a Link in /oic/res with POST request\n",
"parameters": [
{"$ref": "#/parameters/rdgetinterface"}
],
"responses": {
"200": {
"description" : "Respond with the selector criteria - either the set of attributes or the bias factor\n",
"x-example": {
"rt": ["oic.wk.rd"],
"if": ["oic.if.baseline"],
"sel": 50
},
"schema": { "$ref": "#/definitions/rdSelection" }
}
}
},
"post": {
"description": "Publish the Resource information for the first time in /oic/res. Updates to existing entries are not allowed.\nAppropriates parts of the information, i.e., Links of the published Resources will be discovered through /oic/res.\n1) When a Device first publishes a Link, the request payload to RD may include the Links without an \"ins\" Parameter.\n2) Upon granting the request, the RD assigns a unique instance value identifying the Link among all the Links it advertises\n and sends back the instance value in the \"ins\" Parameter in the Link to the publishing Device.\n",
"parameters": [
{"$ref": "#/parameters/rdpostinterface"},
{
"name": "body",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/rdPublish" },
"x-example": {
"di": "e61c3e6b-9c54-4b81-8ce5-f9039c1d04d9",
"links": [
{
"anchor": "ocf://e61c3e6b-9c54-4b81-8ce5-f9039c1d04d9",
"href": "/myLightSwitch",
"rt": [ "oic.r.switch.binary" ],
"if": [ "oic.if.a", "oic.if.baseline" ],
"p": { "bm": 3 },
"eps": [
{ "ep": "coaps://[2001:db8:a::b1d6]:1111", "pri": 2 },
{ "ep": "coaps://[2001:db8:a::b1d6]:1122" },
{ "ep": "coaps+tcp://[2001:db8:a::123]:2222", "pri": 3 }
]
},
{
"anchor": "ocf://e61c3e6b-9c54-4b81-8ce5-f9039c1d04d9",
"href": "/myLightBrightness",
"rt": [ "oic.r.brightness" ],
"if": [ "oic.if.a", "oic.if.baseline" ],
"p": { "bm": 3 },
"eps": [
{ "ep": "coaps://[[2001:db8:a::123]:2222" }
]
}
],
"ttl": 600
}
}
],
"responses": {
"200": {
"description" : "Respond with the same schema as publish with the additional \"ins\" Parameter in the Link.\n",
"x-example": {
"di": "e61c3e6b-9c54-4b81-8ce5-f9039c1d04d9",
"links": [
{
"anchor": "ocf://e61c3e6b-9c54-4b81-8ce5-f9039c1d04d9",
"href": "/myLightSwitch",
"rt": [ "oic.r.switch.binary" ],
"if": [ "oic.if.a", "oic.if.baseline" ],
"p": { "bm": 3 },
"eps": [
{ "ep": "coaps://[2001:db8:a::b1d6]:1111", "pri": 2 },
{ "ep": "coaps://[2001:db8:a::b1d6]:1122" },
{ "ep": "coaps+tcp://[2001:db8:a::123]:2222", "pri": 3 }
],
"ins": 11235
},
{
"anchor": "ocf://e61c3e6b-9c54-4b81-8ce5-f9039c1d04d9",
"href": "/myLightBrightness",
"rt": ["oic.r.brightness"],
"if": ["oic.if.a", "oic.if.baseline"],
"p": {"bm": 3},
"eps": [
{"ep": "coaps://[2001:db8:a::123]:2222"}
],
"ins": 112358
}
],
"ttl": 600
},
"schema": { "$ref": "#/definitions/rdPublish" }
}
}
}
}
},
"parameters": {
"rdgetinterface" : {
"in" : "query",
"name" : "if",
"type" : "string",
"enum" : ["oic.if.baseline"]
},
"rdpostinterface" : {
"in" : "query",
"name" : "if",
"type" : "string",
"enum" : ["oic.if.baseline"]
}
},
"definitions": {
"rdSelection" : {
"properties": {
"rt" : {
"description": "Resource Type of the Resource",
"items": {
"enum": ["oic.wk.rd"],
"type": "string",
"maxLength": 64
},
"minItems": 1,
"uniqueItems": true,
"readOnly": true,
"type": "array"
},
"n" : {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
},
"sel" : {
"description": "A bias factor calculated by the Resource Directory",
"maximum": 100,
"minimum": 0,
"readOnly": true,
"type": "integer"
},
"id" : {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id"
},
"if" : {
"description": "The OCF Interfaces supported by this Resource",
"items": {
"enum": [
"oic.if.baseline"
],
"type": "string",
"maxLength": 64
},
"minItems": 1,
"readOnly": true,
"uniqueItems": true,
"type": "array"
}
},
"type" : "object",
"required": ["sel"]
},
"rdPublish" : {
"properties": {
"di" : {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/di"
},
"ttl" : {
"description": "Time to indicate a RD, i.e. how long to keep this published item.",
"type": "integer"
},
"links" : {
"description": "A set of simple or individual OCF Links.",
"items": {
"properties": {
"anchor": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/anchor"
},
"di": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/di"
},
"eps": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/eps"
},
"href": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/href"
},
"if": {
"description": "The interface set supported by the published resource",
"items": {
"enum": [
"oic.if.baseline",
"oic.if.ll",
"oic.if.b",
"oic.if.rw",
"oic.if.r",
"oic.if.a",
"oic.if.s"
],
"type": "string",
"maxLength": 64
},
"minItems": 1,
"uniqueItems": true,
"type": "array"
},
"ins": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/ins"
},
"p": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/p"
},
"rel": {
"description": "The relation of the target URI referenced by the Link to the context URI",
"oneOf": [
{
"default": [
"hosts"
],
"items": {
"maxLength": 64,
"type": "string"
},
"minItems": 1,
"type": "array"
},
{
"default": "hosts",
"maxLength": 64,
"type": "string"
}
]
},
"rt": {
"description": "Resource Type of the published Resource",
"items": {
"maxLength": 64,
"type": "string"
},
"minItems": 1,
"maxItems": 1,
"uniqueItems": true,
"type": "array"
},
"title": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/title"
},
"type": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/type"
}
},
"required": [
"href",
"rt",
"if"
],
"type": "object"
},
"type": "array"
}
},
"type" : "object",
"required": ["di", "links", "ttl"]
}
}
}