Skip to content

Commit 6bcdacd

Browse files
committed
fixup! Update mdBook GitHub deployment, fix API links
1 parent 2db3cca commit 6bcdacd

2 files changed

Lines changed: 38 additions & 7 deletions

File tree

doc/README.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,44 @@
1-
# Remote Two API Documentation
1+
# Remote Two/3 API Documentation
22

33
- [Remote Two user interface](remote-ui.md)
4+
- [Remote Two entities](entities/README.md)
45
- [Bluetooth HID peripheral support](bt/README.md)
56
- [Remote Two DNS-SD lookup](discovery.md)
67

8+
## Core API
9+
10+
The Unfolded Circle Remote WebSocket & REST Core-APIs allow you to interact with the Unfolded Circle remote-core service
11+
and take full control of its features.
12+
13+
The focus of the Core-APIs is to provide all functionality for the UI application and the web-configurator.
14+
The APIs are specialized for certain tasks, but otherwise contain the same functionality and data models.
15+
16+
- The UCR REST Core-API adds:
17+
- Custom resource handling for uploading icons, images etc.
18+
- Installing custom remote-ui and web-configurator components.
19+
- Installing custom integration drivers.
20+
- User management and authentication handling.
21+
- The UCR WS Core-API adds:
22+
- Event subscription with asynchronous notifications.
23+
24+
The Core-APIs may also be used by other external systems and integration drivers, if specific configuration or
25+
interaction features are required, which are not present in the UCR Integration-API.
26+
27+
The API specifications are defined with [OpenAPI](https://swagger.io/specification/) & [AsyncAPI](https://www.asyncapi.com/)
28+
in YAML format.
29+
30+
- [REST Core-API](https://unfoldedcircle.github.io/core-api/rest/)
31+
- [WebSocket Core-API](https://unfoldedcircle.github.io/core-api/ws/)
32+
733
## Integration API
834

9-
- [Integration AsyncAPI YAML definition](https://unfoldedcircle.github.io/core-api/integration/)
10-
- [Remote Two entities](entities/README.md)
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.
39+
40+
### Integration Driver
41+
1142
- [How to write an integration driver](integration-driver/write-integration-driver.md)
1243
- [WebSockets handling](integration-driver/websocket.md)
1344
- [Driver registration](integration-driver/driver-registration.md)

doc/integration-driver/driver-installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ curl --location 'http://$IP/api/intg/install' \
215215
--form 'file=@"custom-intg.tar.gz"'
216216
```
217217

218-
See [REST Core API](../../core-api/rest/README.md) for more details.
218+
See [REST Core API](https://unfoldedcircle.github.io/core-api/rest/) for more details.
219219

220220
## Delete driver
221221

@@ -225,7 +225,7 @@ These are the same endpoints as for an external network integration driver:
225225
- Delete integration instance `DELETE /api/intg/instances/:intgId`.
226226
- Delete driver and installation files: `DELETE /api/intg/drivers/:driverId`.
227227

228-
See [REST Core API](../../core-api/rest/README.md) for more details.
228+
See [REST Core API](https://unfoldedcircle.github.io/core-api/rest/) for more details.
229229

230230
The instance and driver can also be deleted in the web-configurator.
231231

@@ -236,7 +236,7 @@ Output to stdout and stderr are automatically stored with a timestamp and access
236236
- Get log services: `GET /api/system/logs/services`.
237237
- Query logs: `GET /api/system/logs?...`.
238238

239-
See [REST Core API](../../core-api/rest/README.md) for more details.
239+
See [REST Core API](https://unfoldedcircle.github.io/core-api/rest/) for more details.
240240

241241
Log files can also be downloaded in the web-configurator: _Settings, Development: Logs_
242242

@@ -249,7 +249,7 @@ near real time.
249249

250250
- URL: `http://$IP/log/`
251251
- This function is deactivated by default and the endpoint returns 503.
252-
- The log viewer must be started using the [REST Core API](../../core-api/rest/README.md)
252+
- The log viewer must be started using the [REST Core API](https://unfoldedcircle.github.io/core-api/rest/)
253253
with the `/api/system/logs/web` endpoint:
254254
- `GET` request returns the current state.
255255
- `PUT` request allows to start, stop or to permanently enable the log app. A password can be set to restrict access

0 commit comments

Comments
 (0)