Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 1.97 KB

OPENAPI.md

File metadata and controls

74 lines (51 loc) · 1.97 KB

osiota REST api

This is the osiota REST api documentation. You can find out more about osiota at https://osiota.net/.

Version: 1.0.0

License: MIT

Node

Perform actions on nodes of osiota

/{node}

GET

Summary

Get current value of the node

Description
Parameters
Name Located in Description Required Schema
node path Name of the node Yes string
Responses
Code Description Schema
200 successful operation

Example (One):
{
"value": "Hello World!",
"time": 1588419904.666
}
Node
400 Bad Request
404 Node not found

POST

Summary

Call a RPC function of a node

Description
Parameters
Name Located in Description Required Schema
node path Name of the node Yes string
action body Action template to call No string
method body RPC method to call No string
arguments body Arguments to call No [ any ]
Responses
Code Description Schema
200 successful operation [ any ]
400 Bad Request
404 Node not found
422 Unprocessable Entity Error
500 Internal application error Error

Models

Node

Name Type Description Required
value any Value of a Node
Example: "Hello World"
No
time number Unix timestamp of last alteration
Example: 1588419904.666
No

Error

Name Type Description Required
error string Error string
Example: "Method not found"
No
data any Addional information No