Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Krellian Cloud TDs and documentation for 2024-11 PlugFest #614

Merged
merged 1 commit into from
Nov 24, 2024
Merged

Add Krellian Cloud TDs and documentation for 2024-11 PlugFest #614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions events/2024.11.Munich/Documentation/Krellian Cloud/README.md
View file
Open in desktop
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.
174 changes: 174 additions & 0 deletions events/2024.11.Munich/TDs/Krellian Cloud/cloud.td.json
View file
Open in desktop
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
}
]
}
]
}
}
}