Skip to content

Commit f61a4f5

Browse files
djs0109djs0109
committed
docs: manually add sources files
1 parent a29c9f4 commit f61a4f5

File tree

75 files changed

+1967
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+1967
-0
lines changed

‎example_building_automation/api_docs/swagger-ui/ActuatorFiware/ActuatorFiware.yaml‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
openapi: 3.0.1
2+
info:
3+
title: ActuatorFiware
4+
description: API specification for IoT platform including Actuator Fiwares
5+
version: '1.0'
6+
servers:
7+
- url: http://fiware.rwth-aachen.de/
8+
paths:
9+
/v2/entities:
10+
get:
11+
tags:
12+
- Actuator Fiware
13+
summary: Get Actuator Fiwares
14+
description: Retrieves available actuator fiwares
15+
operationId: getActuatorFiwares
16+
parameters:
17+
- name: type
18+
in: query
19+
description: Entity type, to avoid ambiguity in case there are several entities
20+
with the same entity id.
21+
schema:
22+
type: string
23+
default: ActuatorFiware
24+
- name: Fiware-Service
25+
in: header
26+
required: true
27+
schema:
28+
type: string
29+
default: semantic_iot
30+
- name: Fiware-ServicePath
31+
in: header
32+
required: true
33+
schema:
34+
type: string
35+
default: /
36+
responses:
37+
'200':
38+
description: Successful operation. Returns the entity.
39+
content:
40+
application/json:
41+
schema:
42+
$ref: '#/components/schemas/ActuatorFiware'
43+
'404':
44+
description: Actuator Fiware not found.
45+
content: {}
46+
'500':
47+
description: Internal server error.
48+
content: {}
49+
post:
50+
tags:
51+
- Actuator Fiware
52+
summary: Create Actuator Fiware
53+
description: Creates a new Actuator Fiware entity in the system.
54+
operationId: createActuatorFiware
55+
requestBody:
56+
required: true
57+
content:
58+
application/json:
59+
schema:
60+
$ref: '#/components/schemas/ActuatorFiware'
61+
example:
62+
id: actuatorfiware001
63+
type: ActuatorFiware
64+
parameters:
65+
- name: Fiware-Service
66+
in: header
67+
required: true
68+
schema:
69+
type: string
70+
default: semantic_iot
71+
- name: Fiware-ServicePath
72+
in: header
73+
required: true
74+
schema:
75+
type: string
76+
default: /
77+
responses:
78+
'201':
79+
description: Actuator Fiware successfully created.
80+
content:
81+
application/json:
82+
schema:
83+
$ref: '#/components/schemas/ActuatorFiware'
84+
'400':
85+
description: Invalid input data.
86+
content: {}
87+
'500':
88+
description: Internal server error.
89+
content: {}
90+
components:
91+
schemas:
92+
ActuatorFiware:
93+
additionalProperties: true
94+
description: Base class for Fiware-compatible actuators.
95+
properties:
96+
id:
97+
description: 'Id of an entity in an NGSI context broker. Allowed characters
98+
are the ones in the plain ASCII set, except the following ones: control
99+
characters, whitespace, &, ?, / and #.'
100+
example: Bcn-Welt
101+
maxLength: 256
102+
minLength: 1
103+
title: Entity Id
104+
type: string
105+
type:
106+
anyOf:
107+
- type: string
108+
- enum: []
109+
title: Enum
110+
description: 'Id of an entity in an NGSI context broker. Allowed characters
111+
are the ones in the plain ASCII set, except the following ones: control
112+
characters, whitespace, &, ?, / and #.'
113+
example: Room
114+
maxLength: 256
115+
minLength: 1
116+
title: Entity Type
117+
required:
118+
- id
119+
- type
120+
title: ActuatorFiware
121+
type: object

‎example_building_automation/api_docs/swagger-ui/ActuatorFiware/favicon-16x16.png‎

665 Bytes
Loading

‎example_building_automation/api_docs/swagger-ui/ActuatorFiware/favicon-32x32.png‎

628 Bytes
Loading

‎example_building_automation/api_docs/swagger-ui/ActuatorFiware/index.html‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!-- HTML for static distribution bundle build -->
2+
<!DOCTYPE html>
3+
<html lang="en">
4+
<head>
5+
<meta charset="UTF-8">
6+
<title>Swagger UI</title>
7+
<link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
8+
<link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
9+
<link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
10+
<style>
11+
html
12+
{
13+
box-sizing: border-box;
14+
overflow: -moz-scrollbars-vertical;
15+
overflow-y: scroll;
16+
}
17+
18+
*,
19+
*:before,
20+
*:after
21+
{
22+
box-sizing: inherit;
23+
}
24+
25+
body
26+
{
27+
margin:0;
28+
background: #fafafa;
29+
}
30+
</style>
31+
</head>
32+
33+
<body>
34+
<div id="swagger-ui"></div>
35+
36+
<script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
37+
<script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
38+
<script>
39+
window.onload = function() {
40+
// Begin Swagger UI call region
41+
const ui = SwaggerUIBundle({
42+
configUrl: "swagger-config.json",
43+
dom_id: '#swagger-ui'
44+
})
45+
// End Swagger UI call region
46+
47+
window.ui = ui
48+
}
49+
</script>
50+
</body>
51+
</html>

‎example_building_automation/api_docs/swagger-ui/ActuatorFiware/swagger-config.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"url":"ActuatorFiware.yaml","deepLinking":true}

‎example_building_automation/api_docs/swagger-ui/ActuatorFiware/swagger-ui-bundle.js‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎example_building_automation/api_docs/swagger-ui/ActuatorFiware/swagger-ui-standalone-preset.js‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎example_building_automation/api_docs/swagger-ui/ActuatorFiware/swagger-ui.css‎

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎example_building_automation/api_docs/swagger-ui/CoolingCoilFiware/CoolingCoilFiware.yaml‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
openapi: 3.0.1
2+
info:
3+
title: CoolingCoilFiware
4+
description: API specification for IoT platform including Cooling Coil Fiwares
5+
version: '1.0'
6+
servers:
7+
- url: http://fiware.rwth-aachen.de/
8+
paths:
9+
/v2/entities:
10+
get:
11+
tags:
12+
- Cooling Coil Fiware
13+
summary: Get Cooling Coil Fiwares
14+
description: Retrieves available cooling coil fiwares
15+
operationId: getCoolingCoilFiwares
16+
parameters:
17+
- name: type
18+
in: query
19+
description: Entity type, to avoid ambiguity in case there are several entities
20+
with the same entity id.
21+
schema:
22+
type: string
23+
default: CoolingCoilFiware
24+
- name: Fiware-Service
25+
in: header
26+
required: true
27+
schema:
28+
type: string
29+
default: semantic_iot
30+
- name: Fiware-ServicePath
31+
in: header
32+
required: true
33+
schema:
34+
type: string
35+
default: /
36+
responses:
37+
'200':
38+
description: Successful operation. Returns the entity.
39+
content:
40+
application/json:
41+
schema:
42+
$ref: '#/components/schemas/CoolingCoilFiware'
43+
'404':
44+
description: Cooling Coil Fiware not found.
45+
content: {}
46+
'500':
47+
description: Internal server error.
48+
content: {}
49+
post:
50+
tags:
51+
- Cooling Coil Fiware
52+
summary: Create Cooling Coil Fiware
53+
description: Creates a new Cooling Coil Fiware entity in the system.
54+
operationId: createCoolingCoilFiware
55+
requestBody:
56+
required: true
57+
content:
58+
application/json:
59+
schema:
60+
$ref: '#/components/schemas/CoolingCoilFiware'
61+
example:
62+
id: coolingcoilfiware001
63+
type: CoolingCoilFiware
64+
parameters:
65+
- name: Fiware-Service
66+
in: header
67+
required: true
68+
schema:
69+
type: string
70+
default: semantic_iot
71+
- name: Fiware-ServicePath
72+
in: header
73+
required: true
74+
schema:
75+
type: string
76+
default: /
77+
responses:
78+
'201':
79+
description: Cooling Coil Fiware successfully created.
80+
content:
81+
application/json:
82+
schema:
83+
$ref: '#/components/schemas/CoolingCoilFiware'
84+
'400':
85+
description: Invalid input data.
86+
content: {}
87+
'500':
88+
description: Internal server error.
89+
content: {}
90+
components:
91+
schemas:
92+
CoolingCoilFiware:
93+
additionalProperties: true
94+
description: Extends the CoolingCoil class to include Fiware-specific properties.
95+
properties:
96+
id:
97+
description: 'Id of an entity in an NGSI context broker. Allowed characters
98+
are the ones in the plain ASCII set, except the following ones: control
99+
characters, whitespace, &, ?, / and #.'
100+
example: Bcn-Welt
101+
maxLength: 256
102+
minLength: 1
103+
title: Entity Id
104+
type: string
105+
type:
106+
default: CoolingCoil
107+
title: Type
108+
type: string
109+
hasLocation:
110+
anyOf:
111+
- type: string
112+
- type: 'null'
113+
default: null
114+
title: Haslocation
115+
brand:
116+
anyOf:
117+
- type: string
118+
- type: 'null'
119+
default: null
120+
title: Brand
121+
fanSpeed:
122+
anyOf:
123+
- type: number
124+
- type: 'null'
125+
default: 0
126+
title: Fanspeed
127+
required:
128+
- id
129+
title: CoolingCoilFiware
130+
type: object

‎example_building_automation/api_docs/swagger-ui/CoolingCoilFiware/favicon-16x16.png‎

665 Bytes
Loading

0 commit comments

Comments
 (0)