@c8y/api-doc 1023.52.0 → 1023.55.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -0
- package/package.json +7 -7
package/README.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# API documentation
|
|
2
|
+
|
|
3
|
+
This package allows to view the API documentation of the core and installed microservices.
|
|
4
|
+
|
|
5
|
+
It allows to also try out APIs with the current user session of the browser.
|
|
6
|
+
|
|
7
|
+
The core API documentation is included by default, while installed microservices need to opt in to this functionality by adding an `openApiSpec` property to their manifest, which points to the location where the OpenAPI spec can be retrieved from.
|
|
8
|
+
|
|
9
|
+
## Microservice manifest sample
|
|
10
|
+
|
|
11
|
+
The `ai-agents` microservice uses the contextPath `ai`.
|
|
12
|
+
It offers it's OpenAPI spec under the relative path `api-json` (`/service/ai/api-json`).
|
|
13
|
+
|
|
14
|
+
So the `openApiSpec` has to be set to `api-json`.
|
|
15
|
+
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@c8y/api-doc",
|
|
3
|
-
"version": "1023.
|
|
3
|
+
"version": "1023.55.5",
|
|
4
4
|
"description": "This package is a blueprint application which allows to show all API documentations of the platform.",
|
|
5
5
|
"dependencies": {
|
|
6
|
-
"@c8y/style": "1023.
|
|
7
|
-
"@c8y/ngx-components": "1023.
|
|
8
|
-
"@c8y/client": "1023.
|
|
9
|
-
"@c8y/bootstrap": "1023.
|
|
6
|
+
"@c8y/style": "1023.55.5",
|
|
7
|
+
"@c8y/ngx-components": "1023.55.5",
|
|
8
|
+
"@c8y/client": "1023.55.5",
|
|
9
|
+
"@c8y/bootstrap": "1023.55.5",
|
|
10
10
|
"@angular/cdk": "^20.2.14",
|
|
11
11
|
"monaco-editor": "~0.53.0",
|
|
12
12
|
"ngx-bootstrap": "20.0.2",
|
|
@@ -18,8 +18,8 @@
|
|
|
18
18
|
"enabled": false
|
|
19
19
|
},
|
|
20
20
|
"devDependencies": {
|
|
21
|
-
"@c8y/options": "1023.
|
|
22
|
-
"@c8y/devkit": "1023.
|
|
21
|
+
"@c8y/options": "1023.55.5",
|
|
22
|
+
"@c8y/devkit": "1023.55.5",
|
|
23
23
|
"@types/lodash": "4.17.20"
|
|
24
24
|
},
|
|
25
25
|
"peerDependencies": {
|