-
Notifications
You must be signed in to change notification settings - Fork 10
/
HumidityResURI.swagger.json
139 lines (139 loc) · 4.2 KB
/
HumidityResURI.swagger.json
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
129
130
131
132
133
134
135
136
137
138
139
{
"swagger": "2.0",
"info": {
"title": "Humidity",
"version": "2019-02-15",
"license": {
"name": "OCF Data Model License",
"url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
"x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved."
},
"termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md"
},
"schemes": ["http"],
"consumes": ["application/json"],
"produces": ["application/json"],
"paths": {
"/HumidityResURI" : {
"get": {
"description": "This Resource describes a sensed or desired humidity.\nThe Property \"humidity\" is an integer describing the percentage measured relative humidity.\nThe Property \"desiredHumidity\" is an integer showing the desired target relative humidity.",
"parameters": [
{"$ref": "#/parameters/interface"}
],
"responses": {
"200": {
"description" : "RETRIEVES the current (relative) humidity level.",
"x-example":
{
"rt": ["oic.r.humidity"],
"if": ["oic.if.a", "oic.if.baseline"],
"humidity": 40,
"desiredHumidity": 40
},
"schema": { "$ref": "#/definitions/Humidity" }
}
}
},
"post": {
"description": "Sets the desired relative humidity level.",
"parameters": [
{"$ref": "#/parameters/interface"},
{
"name": "body",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/HumidityUpdate" },
"x-example":
{
"desiredHumidity" : 45
}
}
],
"responses": {
"200": {
"description" : "Indicates that the relative humidity level was changed.\nThe new relative humidity level is provided in the response.",
"x-example":
{
"desiredHumidity": 45
},
"schema": { "$ref": "#/definitions/HumidityUpdate" }
}
}
}
}
},
"parameters": {
"interface": {
"in": "query",
"name": "if",
"type": "string",
"enum": ["oic.if.a", "oic.if.s", "oic.if.baseline"]
}
},
"definitions": {
"Humidity" : {
"properties": {
"rt": {
"description": "The Resource Type.",
"items": {
"enum": ["oic.r.humidity"],
"maxLength": 64,
"type": "string"
},
"minItems": 1,
"uniqueItems": true,
"readOnly": true,
"type": "array"
},
"desiredHumidity": {
"description": "The desired value for humidity.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"humidity": {
"description": "The current sensed value for humidity.",
"maximum": 100,
"minimum": 0,
"readOnly": true,
"type": "integer"
},
"n": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
},
"id": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id"
},
"if": {
"description": "The OCF Interface set supported by this Resource.",
"items": {
"enum": [
"oic.if.a",
"oic.if.s",
"oic.if.baseline"
],
"type": "string"
},
"minItems": 2,
"uniqueItems": true,
"readOnly": true,
"type": "array"
}
},
"type": "object",
"required": ["humidity"]
},
"HumidityUpdate" : {
"properties": {
"desiredHumidity": {
"description": "Desired value for Humidity",
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"type": "object",
"required": ["desiredHumidity"]
}
}
}