-
Notifications
You must be signed in to change notification settings - Fork 10
/
Alarm.swagger.json
178 lines (177 loc) · 4.96 KB
/
Alarm.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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
{
"swagger": "2.0",
"info": {
"title": "Alarm",
"version": "2019-03-04",
"license": {
"name": "OCF Data Model License",
"url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
"x-copyright": "Copyright 2018-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": {
"/AlarmResURI": {
"get": {
"description": "This Resource describes the Properties associated with alarm status.",
"parameters": [
{
"$ref": "#/parameters/interface"
}
],
"responses": {
"200": {
"description": "",
"x-example": {
"rt": [ "oic.r.alarm" ],
"if": [ "oic.if.rw", "oic.if.baseline"],
"status": false,
"duration": 0.0,
"time": "2018-06-20T14:30Z",
"alarmtype": "General"
},
"schema": {
"$ref": "#/definitions/Alarm"
}
}
}
},
"post": {
"description": "This Resource describes the Properties associated with alarm status.",
"parameters": [
{
"$ref": "#/parameters/interface"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/Alarm" },
"x-example": {
"status": true,
"duration": 30.0,
"time": "2019-01-31T14:30Z"
}
}
],
"responses": {
"200": {
"description": "",
"x-example": {
"rt": [
"oic.r.alarm"
],
"status": true,
"duration": 30.0,
"time": "2019-01-31T14:30Z",
"alarmtype": "General"
},
"schema": {
"$ref": "#/definitions/Alarm"
}
}
}
}
}
},
"parameters": {
"interface": {
"in": "query",
"name": "if",
"type": "string",
"enum": [
"oic.if.rw",
"oic.if.baseline"
]
}
},
"definitions": {
"Alarm": {
"properties": {
"rt": {
"description": "The Resource Type.",
"items": {
"enum": [
"oic.r.alarm"
],
"type": "string"
},
"minItems": 1,
"uniqueItems": true,
"readOnly": true,
"type": "array"
},
"status": {
"description": "This Property describes the status of the alarm: true - on, false - off.",
"type": "boolean",
"readOnly": false
},
"duration": {
"description": "This Property describes the alarm duration (seconds).",
"type": "number",
"minimum": 0.0,
"readOnly": false
},
"time": {
"description": "This Property describes the alarm time using ISO 8601 datetime format (e.g: 2007-04-05T14:30Z, 2007-04-05T14:30+09:00).",
"type": "string",
"readOnly": false
},
"alarmtype": {
"description": "The Alarm Type.",
"type": "string",
"enum": [
"General",
"Fire",
"Flood",
"Weather",
"Security"
],
"readOnly": true
},
"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.baseline",
"oic.if.rw"
],
"type": "string"
},
"minItems": 1,
"uniqueItems": true,
"readOnly": true,
"type": "array"
},
"range": {
"$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number"
},
"step": {
"$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number"
},
"precision": {
"$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision"
}
},
"type": "object",
"required": [
"status"
]
}
}
}