-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #614 from benfrancis/2024-11-KrellianCloud
Add Krellian Cloud TDs and documentation for 2024-11 PlugFest
- Loading branch information
Showing
2 changed files
with
191 additions
and
0 deletions.
There are no files selected for viewing
17 changes: 17 additions & 0 deletions
17
events/2024.11.Munich/Documentation/Krellian Cloud/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Krellian Cloud | ||
|
|
||
| [Krellian Cloud](https://krellian.com/cloud/) is a hosted cloud service which provides real-time data analytics for commercial buildings. | ||
|
|
||
| Krellian Cloud provides a WoT Thing Description Directory service and also acts as a Consumer of WoT Thing Descriptions and Things using the HTTP Basic Profile and HTTP SSE Profile. | ||
|
|
||
| The Thing Description in cloud.td.json is the top level Thing Description hosted at https://cloud.krellian.com/.well-known/wot which describes the features of the Directory Service API exposed by the cloud service. | ||
|
|
||
| In order to use Krellian Cloud you need to register for an early access account at https://cloud.krellian.com. I will provide an invitation code to the Web of Things Working Group members mailing list. | ||
|
|
||
| User documentation for Krellian Cloud can be found at https://docs.krellian.com/ | ||
|
|
||
| Krellian Cloud uses HTTP Bearer authentication using JSON Web Tokens (JWT). Once you are logged in it's possible to extract your personal JWT from the Authorization header on authenticated HTTP requests using browser developer tools. | ||
|
|
||
| Krellian Cloud is implemented in Node.js with a MongoDB database acting as an object store and time-series database. It is hosted on Amazon AWS. | ||
|
|
||
| Please email [email protected] with any questions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| { | ||
| "@context": [ | ||
| "https://www.w3.org/2022/wot/td/v1.1", | ||
| "https://w3c.github.io/wot-discovery/context/discovery-context.jsonld" | ||
| ], | ||
| "@type": "ThingDirectory", | ||
| "id": "https://cloud.krellian.com", | ||
| "base": "https://cloud.krellian.com/", | ||
| "title": "Krellian Cloud", | ||
| "securityDefinitions": { | ||
| "bearerScheme": { | ||
| "scheme": "bearer", | ||
| "authorization": "https://cloud.krellian.com", | ||
| "format": "jwt", | ||
| "in": "header", | ||
| "name": "Authorization", | ||
| "alg": "RS256" | ||
| } | ||
| }, | ||
| "security": "bearerScheme", | ||
| "properties": { | ||
| "things": { | ||
| "title": "Things", | ||
| "description": "Retrieve all Thing Descriptions", | ||
| "forms": [ | ||
| { | ||
| "href": "/things", | ||
| "htv:methodName": "GET", | ||
| "response": { | ||
| "description": "Success response", | ||
| "htv:statusCodeValue": 200, | ||
| "contentType": "application/ld+json" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "actions": { | ||
| "createThing": { | ||
| "description": "Create a Thing Description", | ||
| "uriVariables": { | ||
| "id": { | ||
| "@type": "ThingID", | ||
| "title": "Thing Description ID", | ||
| "type": "string", | ||
| "format": "iri-reference" | ||
| } | ||
| }, | ||
| "input": { | ||
| "description": "The schema is implied by the content type", | ||
| "type": "object" | ||
| }, | ||
| "forms": [ | ||
| { | ||
| "href": "/things/{id}", | ||
| "htv:methodName": "PUT", | ||
| "contentType": "application/td+json", | ||
| "response": { | ||
| "description": "Success response", | ||
| "htv:statusCodeValue": 201 | ||
| }, | ||
| "additionalResponses": [ | ||
| { | ||
| "description": "Invalid serialization or TD", | ||
| "contentType": "application/problem+json", | ||
| "htv:statusCodeValue": 400 | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "retrieveThing": { | ||
| "description": "Retrieve a Thing Description", | ||
| "uriVariables": { | ||
| "id": { | ||
| "@type": "ThingID", | ||
| "title": "Thing Description ID", | ||
| "type": "string", | ||
| "format": "iri-reference" | ||
| } | ||
| }, | ||
| "output": { | ||
| "description": "The schema is implied by the content type", | ||
| "type": "object" | ||
| }, | ||
| "safe": true, | ||
| "idempotent": true, | ||
| "forms": [ | ||
| { | ||
| "href": "/things/{id}", | ||
| "htv:methodName": "GET", | ||
| "response": { | ||
| "description": "Success response", | ||
| "htv:statusCodeValue": 200, | ||
| "contentType": "application/td+json" | ||
| }, | ||
| "additionalResponses": [ | ||
| { | ||
| "description": "TD with the given id not found", | ||
| "contentType": "application/problem+json", | ||
| "htv:statusCodeValue": 404 | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "partiallyUpdateThing": { | ||
| "description": "Partially update a Thing Description", | ||
| "uriVariables": { | ||
| "id": { | ||
| "@type": "ThingID", | ||
| "title": "Thing Description ID", | ||
| "type": "string", | ||
| "format": "iri-reference" | ||
| } | ||
| }, | ||
| "input": { | ||
| "description": "The schema is implied by the content type", | ||
| "type": "object" | ||
| }, | ||
| "forms": [ | ||
| { | ||
| "href": "/things/{id}", | ||
| "htv:methodName": "PATCH", | ||
| "contentType": "application/merge-patch+json", | ||
| "response": { | ||
| "description": "Success response", | ||
| "htv:statusCodeValue": 204 | ||
| }, | ||
| "additionalResponses": [ | ||
| { | ||
| "description": "Invalid serialization or TD", | ||
| "contentType": "application/problem+json", | ||
| "htv:statusCodeValue": 400 | ||
| }, | ||
| { | ||
| "description": "TD with the given id not found", | ||
| "contentType": "application/problem+json", | ||
| "htv:statusCodeValue": 404 | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "deleteThing": { | ||
| "description": "Delete a Thing Description", | ||
| "uriVariables": { | ||
| "id": { | ||
| "@type": "ThingID", | ||
| "title": "Thing Description ID", | ||
| "type": "string", | ||
| "format": "iri-reference" | ||
| } | ||
| }, | ||
| "forms": [ | ||
| { | ||
| "href": "/things/{id}", | ||
| "htv:methodName": "DELETE", | ||
| "response": { | ||
| "description": "Success response", | ||
| "htv:statusCodeValue": 204 | ||
| }, | ||
| "additionalResponses": [ | ||
| { | ||
| "description": "TD with the given id not found", | ||
| "contentType": "application/problem+json", | ||
| "htv:statusCodeValue": 404 | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } |