- The informative
- Declarative Protocol Binding Illustration provided below illustrates
- how a Consumer conforming to the Core Profile would interpret the above
- Thing Description once all of the defaults and protocol definitions
- from the Core Profile Protocol Binding have been applied.
+ The informative declarative protocol binding example in
+ Appendix A
+ illustrates how the concrete protocol binding defined in this section
+ would have to be represented in a Thing Description if it did not use
+ the profiling mechanism. In other words, if all of the defaults and
+ protocol specifics defined in this section were instead provided
+ declaratively using hypermedia
+
+ Forms, with all defaults made explicit.
- The following informative Thing Description serves to illustrate how - the example Thing Description in EXAMPLE 3 - would look if the full Core Profile Protocol Binding was provided - declaratively in the Thing Description, with all defaults made - explicit. -
-- This example is only an illustration of a machine-readable version of - the Core Profile Protocol Binding and a demonstration of how Web - Things conforming to the Core Profile can benefit from more concise - Thing Descriptions. A Consumer conforming to the Core Profile would - only require the significantly more concise form shown in - EXAMPLE 3 in order to derive the same - information. -
-
- {
- "@context": "https://www.w3.org/2019/wot/td/v1",
- "id": "https://mywebthingserver.com/things/lamp",
- "base": "https://mywebthingserver.com/things/lamp/",
- "title": "My Lamp",
- "description": "A web connected lamp",
- "securityDefinitions": {
- "oauth2": {
- "scheme": "oauth2",
- "flow": "code",
- "authorization": "https://mywebthingserver.com/oauth/authorize",
- "token": "https://mywebthingserver.com/oauth/token"
+
+ JSON Schema of the Core Profile
+
+ A Thing Description can be syntactically validated with the JSON Schema [[?JSON-SCHEMA]] for compliance with
+ the core profile.
+
+
+ Todo: Define a JSON-SCHEMA.
+
+
+
+ The following informative Thing Description illustrates how the concrete
+ protocol binding defined in the Core Profile
+ would have to be represented by the Web Thing described by
+ EXAMPLE 3 if it did not use the
+ profiling mechanism. In other words, if
+ all of the defaults and protocol specifics defined in the Core Profile
+ protocol binding were instead provided
+ declaratively using hypermedia
+
+ Forms, with all defaults made explicit.
+
+ This example is only intended as an illustration of how Web + Things conforming to the Core Profile can benefit from more concise + Thing Descriptions. A Web Thing which does use the profiling mechanism + would only need to use the significantly more concise form shown in + EXAMPLE 3 in order to provide the same information. +
+
+ {
+ "@context": "https://www.w3.org/2019/wot/td/v1",
+ "id": "https://mywebthingserver.com/things/lamp",
+ "base": "https://mywebthingserver.com/things/lamp/",
+ "title": "My Lamp",
+ "description": "A web connected lamp",
+ "securityDefinitions": {
+ "oauth2": {
+ "scheme": "oauth2",
+ "flow": "code",
+ "authorization": "https://mywebthingserver.com/oauth/authorize",
+ "token": "https://mywebthingserver.com/oauth/token"
+ }
+ },
+ "security": "oauth2",
+ "properties": {
+ "on": {
+ "type": "boolean",
+ "title": "On/Off",
+ "description": "Whether the lamp is turned on",
+ "forms": [
+ {
+ "op": "readproperty",
+ "href": "./properties/on",
+ "htv:methodName": "GET",
+ "htv:headers": [{
+ "htv:fieldName": "Accept",
+ "htv:fieldValue": "application/json"
+ }],
+ "response": {
+ "htv:statusCodeNumber": 200,
+ "contentType": "application/json"
+ }
+ },
+ {
+ "op": "writeproperty",
+ "href": "./properties/on",
+ "htv:methodName": "PUT",
+ "contentType": "application/json",
+ "response": {
+ "htv:statusCodeNumber": 204
+ }
+ }
+ ]
+ },
+ "level" : {
+ "type": "integer",
+ "title": "Brightness",
+ "description": "The level of light from 0-100",
+ "unit": "percent",
+ "minimum" : 0,
+ "maximum" : 100,
+ "forms": [
+ {
+ "op": "readproperty",
+ "href": "./properties/level",
+ "htv:methodName": "GET",
+ "htv:headers": [{
+ "htv:fieldName": "Accept",
+ "htv:fieldValue": "application/json"
+ }],
+ "response": {
+ "htv:statusCodeNumber": 200,
+ "contentType": "application/json"
}
},
- "security": "oauth2",
+ {
+ "op": "writeproperty",
+ "href": "./properties/level",
+ "htv:methodName": "PUT",
+ "contentType": "application/json",
+ "response": {
+ "htv:statusCodeNumber": 204
+ }
+ }
+ ]
+ }
+ },
+ "actions": {
+ "fade": {
+ "title": "Fade",
+ "description": "Fade the lamp to a given level",
+ "input": {
+ "type": "object",
"properties": {
- "on": {
- "type": "boolean",
- "title": "On/Off",
- "description": "Whether the lamp is turned on",
- "forms": [
- {
- "op": "readproperty",
- "href": "./properties/on",
- "htv:methodName": "GET",
- "htv:headers": [{
- "htv:fieldName": "Accept",
- "htv:fieldValue": "application/json"
- }],
- "response": {
- "htv:statusCodeNumber": 200,
- "contentType": "application/json"
- }
- },
- {
- "op": "writeproperty",
- "href": "./properties/on",
- "htv:methodName": "PUT",
- "contentType": "application/json",
- "response": {
- "htv:statusCodeNumber": 204
- }
- }
- ]
+ "level": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 100,
+ "unit": "percent"
},
- "level" : {
+ "duration": {
"type": "integer",
- "title": "Brightness",
- "description": "The level of light from 0-100",
- "unit": "percent",
- "minimum" : 0,
- "maximum" : 100,
- "forms": [
- {
- "op": "readproperty",
- "href": "./properties/level",
- "htv:methodName": "GET",
- "htv:headers": [{
- "htv:fieldName": "Accept",
- "htv:fieldValue": "application/json"
- }],
- "response": {
- "htv:statusCodeNumber": 200,
- "contentType": "application/json"
- }
- },
- {
- "op": "writeproperty",
- "href": "./properties/level",
- "htv:methodName": "PUT",
- "contentType": "application/json",
- "response": {
- "htv:statusCodeNumber": 204
- }
- }
- ]
+ "minimum": 0,
+ "unit": "milliseconds"
}
- },
- "actions": {
- "fade": {
- "title": "Fade",
- "description": "Fade the lamp to a given level",
- "input": {
- "type": "object",
- "properties": {
- "level": {
- "type": "integer",
- "minimum": 0,
- "maximum": 100,
- "unit": "percent"
- },
- "duration": {
- "type": "integer",
- "minimum": 0,
- "unit": "milliseconds"
- }
- }
- },
- "forms": [
- {
- "op": "invokeaction",
- "href": "./actions/fade",
- "htv:methodName": "POST",
- "contentType": "application/json",
- "htv:headers": [{
- "htv:fieldName": "Accept",
- "htv:fieldValue": "application/json"
- }],
- "response": {
- "htv:statusCodeNumber": 201,
- "htv:headers": [
- {
- "htv:fieldName": "Location",
- "htv:fieldValue": "/fade/{id}"
- }
- ],
- "contentType": "application/json",
- "schema": "actionStatus"
- },
- "additionalResponses": [
- {
- "htv:statusCodeNumber": 200,
- "htv:headers": [
- {
- "htv:fieldName": "Location",
- "htv:fieldValue": "/fade/{id}"
- }
- ],
- "contentType": "application/json",
- "schema": "actionStatus"
- }
- ]
- },
- {
- "op": "queryaction",
- "href": "./actions/fade/{id}",
- "htv:methodName": "GET",
- "htv:headers": [{
- "htv:fieldName": "Accept",
- "htv:fieldValue": "application/json"
- }],
- "response": {
- "contentType": "application/json",
- "schema": "actionStatus"
- }
- },
+ }
+ },
+ "forms": [
+ {
+ "op": "invokeaction",
+ "href": "./actions/fade",
+ "htv:methodName": "POST",
+ "contentType": "application/json",
+ "htv:headers": [{
+ "htv:fieldName": "Accept",
+ "htv:fieldValue": "application/json"
+ }],
+ "response": {
+ "htv:statusCodeNumber": 201,
+ "htv:headers": [
{
- "op": "cancelaction",
- "href": "./actions/fade/{id}",
- "htv:methodName": "DELETE",
- "contentType": "application/json"
+ "htv:fieldName": "Location",
+ "htv:fieldValue": "/fade/{id}"
}
],
- "uriVariables": {
- "id": {
- "type": "string",
- "description": "identifier of action request"
- }
+ "contentType": "application/json",
+ "schema": "actionStatus"
+ },
+ "additionalResponses": [
+ {
+ "htv:statusCodeNumber": 200,
+ "htv:headers": [
+ {
+ "htv:fieldName": "Location",
+ "htv:fieldValue": "/fade/{id}"
+ }
+ ],
+ "contentType": "application/json",
+ "schema": "actionStatus"
}
- }
+ ]
},
- "events": {
- "overheated": {
- "title": "Overheated",
- "data": {
- "type": "number",
- "unit": "degree celsius"
- },
- "description": "The lamp has exceeded its safe operating temperature",
- "forms": [
- {
- "op": "subscribeevent",
- "href": "./events/overheated",
- "subprotocol": "sse",
- "htv:methodName": "GET",
- "htv:headers": [
- {
- "htv:fieldName": "Accept",
- "htv:fieldValue": "text/event-stream"
- },
- {
- "htv:fieldName": "Connection",
- "htv:fieldValue": "keep-alive"
- }
- ],
- "response": {
- "htv:statusCodeNumber": 200,
- "contentType": "text/event-stream"
- }
- },
- {
- "op": "unbsubscribeevent",
- "href": "./events/overheated",
- "subprotocol": "sse"
- }
- ]
+ {
+ "op": "queryaction",
+ "href": "./actions/fade/{id}",
+ "htv:methodName": "GET",
+ "htv:headers": [{
+ "htv:fieldName": "Accept",
+ "htv:fieldValue": "application/json"
+ }],
+ "response": {
+ "contentType": "application/json",
+ "schema": "actionStatus"
}
},
- "forms": [
- {
- "op": "readallproperties",
- "href": "./properties",
- "htv:methodName": "GET",
- "htv:headers": [{
- "htv:fieldName": "Accept",
- "htv:fieldValue": "application/json"
- }],
- "response": {
- "htv:statusCodeNumber": 200,
- "contentType": "application/json"
- }
- },
- {
- "op": "writemultipleproperties",
- "href": "./properties",
- "htv:methodName": "PUT",
- "contentType": "application/json",
- "response": {
- "htv:statusCodeNumber": 204
- }
- },
- {
- "op": "queryallactions",
- "href": "./actions",
- "htv:methodName": "GET",
- "htv:headers": [{
+ {
+ "op": "cancelaction",
+ "href": "./actions/fade/{id}",
+ "htv:methodName": "DELETE",
+ "contentType": "application/json"
+ }
+ ],
+ "uriVariables": {
+ "id": {
+ "type": "string",
+ "description": "identifier of action request"
+ }
+ }
+ }
+ },
+ "events": {
+ "overheated": {
+ "title": "Overheated",
+ "data": {
+ "type": "number",
+ "unit": "degree celsius"
+ },
+ "description": "The lamp has exceeded its safe operating temperature",
+ "forms": [
+ {
+ "op": "subscribeevent",
+ "href": "./events/overheated",
+ "subprotocol": "sse",
+ "htv:methodName": "GET",
+ "htv:headers": [
+ {
"htv:fieldName": "Accept",
- "htv:fieldValue": "application/json"
- }],
- "response": {
- "contentType": "application/json",
- "schema": "actionStatusList"
- }
- },
- {
- "op": "subscribeallevents",
- "href": "./events",
- "subprotocol": "sse",
- "htv:methodName": "GET",
- "htv:headers": [
- {
- "htv:fieldName": "Accept",
- "htv:fieldValue": "text/event-stream"
- },
- {
- "htv:fieldName": "Connection",
- "htv:fieldValue": "keep-alive"
- }
- ],
- "response": {
- "htv:statusCodeNumber": 200,
- "contentType": "text/event-stream"
+ "htv:fieldValue": "text/event-stream"
+ },
+ {
+ "htv:fieldName": "Connection",
+ "htv:fieldValue": "keep-alive"
}
- },
- {
- "op": "unsubscribeallevents",
- "href": "./events",
- "subprotocol": "sse"
+ ],
+ "response": {
+ "htv:statusCodeNumber": 200,
+ "contentType": "text/event-stream"
}
- ],
- "schemaDefinitions": {
- "actionStatus": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "pending",
- "running",
- "completed",
- "failed"
- ]
- },
- "error": {
- "type": "object"
- },
- "href": {
- "type": "string",
- "format": "uri",
- "const": "./actions/fade/{id}"
- }
- },
- "required": [
- "status"
+ },
+ {
+ "op": "unbsubscribeevent",
+ "href": "./events/overheated",
+ "subprotocol": "sse"
+ }
+ ]
+ }
+ },
+ "forms": [
+ {
+ "op": "readallproperties",
+ "href": "./properties",
+ "htv:methodName": "GET",
+ "htv:headers": [{
+ "htv:fieldName": "Accept",
+ "htv:fieldValue": "application/json"
+ }],
+ "response": {
+ "htv:statusCodeNumber": 200,
+ "contentType": "application/json"
+ }
+ },
+ {
+ "op": "writemultipleproperties",
+ "href": "./properties",
+ "htv:methodName": "PUT",
+ "contentType": "application/json",
+ "response": {
+ "htv:statusCodeNumber": 204
+ }
+ },
+ {
+ "op": "queryallactions",
+ "href": "./actions",
+ "htv:methodName": "GET",
+ "htv:headers": [{
+ "htv:fieldName": "Accept",
+ "htv:fieldValue": "application/json"
+ }],
+ "response": {
+ "contentType": "application/json",
+ "schema": "actionStatusList"
+ }
+ },
+ {
+ "op": "subscribeallevents",
+ "href": "./events",
+ "subprotocol": "sse",
+ "htv:methodName": "GET",
+ "htv:headers": [
+ {
+ "htv:fieldName": "Accept",
+ "htv:fieldValue": "text/event-stream"
+ },
+ {
+ "htv:fieldName": "Connection",
+ "htv:fieldValue": "keep-alive"
+ }
+ ],
+ "response": {
+ "htv:statusCodeNumber": 200,
+ "contentType": "text/event-stream"
+ }
+ },
+ {
+ "op": "unsubscribeallevents",
+ "href": "./events",
+ "subprotocol": "sse"
+ }
+ ],
+ "schemaDefinitions": {
+ "actionStatus": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "pending",
+ "running",
+ "completed",
+ "failed"
+ ]
+ },
+ "error": {
+ "type": "object"
+ },
+ "href": {
+ "type": "string",
+ "format": "uri",
+ "const": "./actions/fade/{id}"
+ }
+ },
+ "required": [
+ "status"
+ ]
+ },
+ "actionStatusList": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "pending",
+ "running",
+ "completed",
+ "failed"
]
},
- "actionStatusList": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "pending",
- "running",
- "completed",
- "failed"
- ]
- },
- "error": {
- "type": "object"
- },
- "href": {
- "type": "string",
- "format": "uri",
- "const": "./actions/fade/{id}"
- }
- },
- "required": [
- "status"
- ]
- }
+ "error": {
+ "type": "object"
+ },
+ "href": {
+ "type": "string",
+ "format": "uri",
+ "const": "./actions/fade/{id}"
}
- }
+ },
+ "required": [
+ "status"
+ ]
}
-
- - A Thing Description can be syntactically validated with the JSON Schema [[?JSON-SCHEMA]] for compliance with - the core profile. -
-- Todo: Define a JSON-SCHEMA. -
+ } + } + } + +