Repository navigation
Conversation
|
we tagged 1.1.3 please remove the preview label from the 1.1.3 release notes |
Done with #7067 |
| @@ -23,6 +23,33 @@ For an example of how you can authenticate requests to these APIs, refer to the | |||
| > [!TIP] | |||
| > For the full source code of these scripts, go to the [DocumentHub Solution repository](https://github.com/SkylineCommunications/SLC-S-DocumentHub) on GitHub (look for projects starting with `SLC-DH-UDAPI-*`). | |||
|
|
|||
| ## API specification | |||
|
|
|||
| The DocumentHub Solution repository contains a single OpenAPI specification for all `SLC-DH-UDAPI-*` scripts. The specification, `docs/openapi/DocumentHub.json`, lists the routes, HTTP methods, and request and response models, grouped by API. To access it, go to the [DocumentHub Solution repository](https://github.com/SkylineCommunications/SLC-S-DocumentHub) on GitHub and open `docs/openapi/DocumentHub.json`. | |||
There was a problem hiding this comment.
The SLC-S-DocumentHub repo is not public. If this will remain a private repo, we will need to clarify this here so external users know why they can't reach it.
|
|
||
| ## API Explorer | ||
|
|
||
| The `DocumentHub` and `DocumentHub-Internal` packages publish the OpenAPI specification to the DataMiner Agent when installed. You can browse it with the [Skyline API Explorer](https://catalog.dataminer.services/details/33d3f002-f7bf-46f3-9405-f491b6f84453?q=api%20explorer): |
There was a problem hiding this comment.
This Catalog item is not public. If there's no intention to publish this, we will need to clarify that this is only accessible for Skyline employees.
There was a problem hiding this comment.
DocumentHub catalog is public https://catalog.dataminer.services/details/f9720b2e-fdaa-4956-9788-877328b587ca the internal not, suggest to remove DocumentHub-Internal references.
This pull request enhances the documentation for DocumentHub by introducing details about the OpenAPI specification and improving integration guidance. The main changes include adding a new section describing the OpenAPI specification, default API routes, and instructions for using the API Explorer, as well as updating integration options to highlight HTTP-based custom integrations.
API documentation improvements:
DH_UDAPI.mddescribing the location and usage of the OpenAPI specification (docs/openapi/DocumentHub.json), including a table of default API routes and instructions for using OpenAPI viewers like Swagger Editor.Integration guidance updates:
DocumentHub.mdto mention that custom integrations can use the DocumentHub user-defined APIs over HTTP, with a reference to the relevant documentation.