/
openapi.yaml
128 lines (128 loc) · 3.03 KB
/
openapi.yaml
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
swagger: "2.0"
info:
description: "This is the osiota REST api documentation. You can find out more about osiota at [https://osiota.net/](https://osiota.net/)."
version: "1.0.0"
title: "osiota REST api"
license:
name: "MIT"
url: "https://github.com/osiota/osiota/blob/master/LICENSE"
basePath: "/"
tags:
- name: "Node"
description: "Perform actions on nodes of osiota"
schemes:
- "https"
- "http"
paths:
/{node}:
get:
tags:
- "Node"
summary: "Get current value of the node"
description: ""
produces:
- "application/json"
parameters:
- name: "node"
in: "path"
description: "Name of the node"
required: true
type: "string"
examples:
One: "/test"
responses:
"200":
description: "successful operation"
schema:
$ref: '#/definitions/Node'
examples:
One:
value: 'Hello World!'
time: 1588419904.666
"400":
description: "Bad Request"
"404":
description: "Node not found"
post:
tags:
- "Node"
summary: "Call a RPC function of a node"
description: ""
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "path"
name: "node"
description: "Name of the node"
required: true
type: "string"
examples:
One: "/test"
- in: "body"
name: "action"
description: "Action template to call"
required: false
type: "string"
examples:
One: "on"
- in: "body"
name: "method"
description: "RPC method to call"
required: false
type: "string"
examples:
One: "set"
- in: "body"
name: "arguments"
description: "Arguments to call"
required: false
type: "array"
items:
type: "any"
examples:
One:
- false
- 1234567
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
type: "any"
"400":
description: "Bad Request"
"404":
description: "Node not found"
"422":
description: "Unprocessable Entity"
schema:
$ref: '#/definitions/Error'
"500":
description: "Internal application error"
schema:
$ref: '#/definitions/Error'
definitions:
Node:
type: "object"
properties:
value:
type: "any"
description: "Value of a Node"
example: "Hello World"
time:
type: "number"
description: "Unix timestamp of last alteration"
example: 1588419904.666
Error:
type: "object"
properties:
error:
type: "string"
description: "Error string"
example: "Method not found"
data:
type: "any"
description: "Addional information"