Skip to content

Commit 58cccb9

Browse files
committed
fixup! Publish OpenAPI & swagger-ui to GH pages
1 parent ab106d5 commit 58cccb9

5 files changed

Lines changed: 29 additions & 6 deletions

File tree

-175 Bytes
Loading
-40 Bytes
Loading
7.23 KB
Binary file not shown.

core-api/rest/swagger-ui/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
<script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
99
<link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
1010
<link rel="stylesheet" type="text/css" href="index.css" />
11+
<link rel="icon" href="./favicon.ico" />
1112
<link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
1213
<link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
1314
</head>

doc/README.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,37 @@ interaction features are required, which are not present in the UCR Integration-
2727
The API specifications are defined with [OpenAPI](https://swagger.io/specification/) & [AsyncAPI](https://www.asyncapi.com/)
2828
in YAML format.
2929

30-
- [REST Core-API](https://unfoldedcircle.github.io/core-api/rest/)
31-
- [WebSocket Core-API](https://unfoldedcircle.github.io/core-api/ws/)
30+
- [REST Core-API documentation viewer](https://unfoldedcircle.github.io/core-api/rest/)
31+
- [REST Core-API YAML definition](https://github.com/unfoldedcircle/core-api/tree/main/core-api/rest)
32+
- [WebSocket Core-API documentation viewer](https://unfoldedcircle.github.io/core-api/ws/)
33+
- [WebSocket Core-API YAML definition](https://github.com/unfoldedcircle/core-api/tree/main/core-api/websocket)
34+
35+
## Dock API
36+
37+
The Remote Two/3 WebSocket Dock-API allows you to directly interact with the Unfolded Circle smart charging docks and
38+
take full control of its features.
39+
40+
The API specification is defined with [AsyncAPI](https://www.asyncapi.com/) in YAML format.
41+
The WebSocket communication is using text messages with JSON payload.
42+
43+
- [Dock AsyncAPI documentation viewer](https://unfoldedcircle.github.io/core-api/dock/)
44+
- [Dock AsyncAPI YAML definition](https://github.com/unfoldedcircle/core-api/tree/main/dock-api)
45+
- View with the [AsyncAPI Studio online tool](https://studio.asyncapi.com/?url=https://raw.githubusercontent.com/unfoldedcircle/core-api/main/dock-api/UCD2-asyncapi.yaml).
46+
The link will directly load the yaml definition file from GitHub and display it together with the HTML documentation
47+
in the browser.
3248

3349
## Integration API
3450

35-
- [Integration AsyncAPI definition](https://unfoldedcircle.github.io/core-api/integration/)
36-
- View with [AsyncAPI Studio online tool](https://studio.asyncapi.com/?url=https://raw.githubusercontent.com/unfoldedcircle/core-api/main/integration-api/UCR-integration-asyncapi.yaml).
37-
The link will directly load the yaml definition file from GitHub and display it together with the HTML documentation in
38-
the browser.
51+
The Unfolded Circle WebSocket Integration-API allows writing device integration drivers for the Unfolded Circle Remotes.
52+
53+
The API specification is defined with [AsyncAPI](https://www.asyncapi.com/) in YAML format.
54+
The WebSocket communication is using text messages with JSON payload.
55+
56+
- [Integration AsyncAPI viewer](https://unfoldedcircle.github.io/core-api/integration/)
57+
- [Integration AsyncAPI YAML definition](https://unfoldedcircle.github.io/core-api/integration/)
58+
- View with [AsyncAPI Studio online tool](https://studio.asyncapi.com/?url=https://raw.githubusercontent.com/unfoldedcircle/core-api/main/integration-api/UCR-integration-asyncapi.yaml).
59+
The link will directly load the yaml definition file from GitHub and display it together with the HTML documentation
60+
in the browser.
3961

4062
### Integration Driver
4163

0 commit comments

Comments
 (0)