Skip to content

Commit aada990

Browse files
committed
Correct documentation link
1 parent 1c06884 commit aada990

File tree

2 files changed

+13
-18
lines changed

2 files changed

+13
-18
lines changed

metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
],
1515
"apiUrl": "v1",
1616
"apiSpecificationPath": "/version/openapi.json",
17-
"documentationUrl": "https://doc.eliona.io/collection/v/eliona-english/eliona-apps/apps/hailo",
17+
"documentationUrl": "https://doc.eliona.io/collection/eliona-english/eliona-apps/apps/hailo",
1818
"useEnvironment": [
1919
"CONNECTION_STRING",
2020
"INIT_CONNECTION_STRING",

openapi.yaml

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ info:
2121
description: API to access and configure the Hailo app
2222
externalDocs:
2323
description: Find out more about the Hailo app
24-
url: https://github.com/eliona-smart-building-assistant/hailo-app
24+
url: https://doc.eliona.io/collection/eliona-english/eliona-apps/apps/hailo
2525
servers:
2626
- url: http://hailo/v1
2727

@@ -45,7 +45,6 @@ tags:
4545
description: API version
4646

4747
paths:
48-
4948
/configs:
5049
get:
5150
tags:
@@ -61,7 +60,7 @@ paths:
6160
schema:
6261
type: array
6362
items:
64-
$ref: '#/components/schemas/Configuration'
63+
$ref: "#/components/schemas/Configuration"
6564
post:
6665
tags:
6766
- Configuration
@@ -72,14 +71,14 @@ paths:
7271
content:
7372
application/json:
7473
schema:
75-
$ref: '#/components/schemas/Configuration'
74+
$ref: "#/components/schemas/Configuration"
7675
responses:
7776
201:
7877
description: Successfully created a new Hailo FDS endpoint
7978
content:
8079
application/json:
8180
schema:
82-
$ref: '#/components/schemas/Configuration'
81+
$ref: "#/components/schemas/Configuration"
8382

8483
/configs/{config-id}:
8584
get:
@@ -88,42 +87,42 @@ paths:
8887
summary: Get FDS endpoint
8988
description: Gets information about the FDS endpoint with the given id
9089
parameters:
91-
- $ref: '#/components/parameters/config-id'
90+
- $ref: "#/components/parameters/config-id"
9291
operationId: getConfigurationById
9392
responses:
9493
200:
9594
description: Successfully returned configured FDS endpoint
9695
content:
9796
application/json:
9897
schema:
99-
$ref: '#/components/schemas/Configuration'
98+
$ref: "#/components/schemas/Configuration"
10099
put:
101100
tags:
102101
- Configuration
103102
summary: Updates an FDS endpoint
104103
description: Updates an FDS endpoint.
105104
parameters:
106-
- $ref: '#/components/parameters/config-id'
105+
- $ref: "#/components/parameters/config-id"
107106
operationId: putConfigurationById
108107
requestBody:
109108
content:
110109
application/json:
111110
schema:
112-
$ref: '#/components/schemas/Configuration'
111+
$ref: "#/components/schemas/Configuration"
113112
responses:
114113
200:
115114
description: Successfully updates a Hailo FDS endpoint
116115
content:
117116
application/json:
118117
schema:
119-
$ref: '#/components/schemas/Configuration'
118+
$ref: "#/components/schemas/Configuration"
120119
delete:
121120
tags:
122121
- Configuration
123122
summary: Deletes a FDS endpoint
124123
description: Removes information about the FDS endpoint with the given id
125124
parameters:
126-
- $ref: '#/components/parameters/config-id'
125+
- $ref: "#/components/parameters/config-id"
127126
operationId: deleteConfigurationById
128127
responses:
129128
204:
@@ -152,7 +151,7 @@ paths:
152151
schema:
153152
type: array
154153
items:
155-
$ref: '#/components/schemas/AssetMapping'
154+
$ref: "#/components/schemas/AssetMapping"
156155

157156
/dashboard-templates/{dashboard-template-name}:
158157
get:
@@ -185,7 +184,7 @@ paths:
185184
content:
186185
application/json:
187186
schema:
188-
$ref: 'https://raw.githubusercontent.com/eliona-smart-building-assistant/eliona-api/main/openapi.yaml#/components/schemas/Dashboard'
187+
$ref: "https://raw.githubusercontent.com/eliona-smart-building-assistant/eliona-api/main/openapi.yaml#/components/schemas/Dashboard"
189188
404:
190189
description: Template with name not found
191190

@@ -204,7 +203,6 @@ paths:
204203
schema:
205204
type: object
206205

207-
208206
/version/openapi.json:
209207
get:
210208
summary: OpenAPI specification for this API version
@@ -221,9 +219,7 @@ paths:
221219
type: object
222220

223221
components:
224-
225222
parameters:
226-
227223
config-id:
228224
name: config-id
229225
in: path
@@ -236,7 +232,6 @@ components:
236232
example: 4711
237233

238234
schemas:
239-
240235
Configuration:
241236
type: object
242237
description: Each configuration defines access to an Hailo FDS endpoint with configurable timeouts and polling intervals. Each FDS endpoint delivers information about a set of Hailo smart devices.

0 commit comments

Comments
 (0)