Skip to content

Commit

Permalink
Moved Configuration Rest API pages to reference section
Browse files Browse the repository at this point in the history
  • Loading branch information
salvatore-coppola committed Nov 17, 2023
1 parent 47145df commit b80937c
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/administration/snapshot-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The **Download** option provides the ability to save a snapshot file onto your c
Starting from Kura 5.1, the snapshot can be downloaded in two formats:

* **XML**: The original XML snapshot format.
* **JSON**: The JSON format used by the [Configuration v2 REST APIs and CONF-V2 request handler](../core-services/configuration-service-rest-v2.md). For example the downloaded snapshot can be used as is as a body for the [PUT/configurableComponents/configurations/_update](../core-services/configuration-service-rest-v2.md) request. The `takeSnapshot` parameter specified by the CONF-V2 request is missing from the downloaded JSON file, if that parameter is not specified, a new snapshot will be created by default.
* **JSON**: The JSON format used by the [Configuration v2 REST APIs and CONF-V2 request handler](../references/rest-apis/rest-configuration-service-v2.md). For example the downloaded snapshot can be used as is as a body for the [PUT/configurableComponents/configurations/_update](../references/rest-apis/rest-configuration-service-v2.md) request. The `takeSnapshot` parameter specified by the CONF-V2 request is missing from the downloaded JSON file, if that parameter is not specified, a new snapshot will be created by default.

Pressing the **Download** button will trigger a dialog that allows choosing the desired format.

Expand Down
7 changes: 1 addition & 6 deletions docs/core-services/configuration-service.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
# Configuration Service

The Configuration Service is responsible to manage the framework configuration by creating and persisting the framework snapshot. Built on top of the OSGi Configuration Admin and Metatype services, it is also responsible to track and manage the creation and deletion of service instances as well as OSGi component factories.

The Configuration Service is accessible using the following REST APIs and cloud request handlers:

* [Configuration V1 REST APIs](./configuration-service-rest-v1.md) (deprecated)
* [Configuration V2 REST APIs and CONF-V2 request handler](./configuration-service-rest-v2.md)
The Configuration Service is responsible to manage the framework configuration by creating and persisting the framework snapshot. Built on top of the OSGi Configuration Admin and Metatype services, it is also responsible to track and manage the creation and deletion of service instances as well as OSGi component factories.
7 changes: 3 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,7 @@ nav:
- Clock Service: core-services/clock-service.md
- Deployment Service: core-services/deployment-service.md
- Command Service: core-services/command-service.md
- Configuration Service:
- Configuration Service: core-services/configuration-service.md
- Configuration V1 REST APIs: core-services/configuration-service-rest-v1.md
- Configuration V2 REST APIs and CONF-V2 Request Handler: core-services/configuration-service-rest-v2.md
- Configuration Service: core-services/configuration-service.md
- H2Db Service: core-services/h2db-service.md
- SQLite DB Service: core-services/sqlite-db-service.md
- Position Service: core-services/position-service.md
Expand Down Expand Up @@ -150,6 +147,8 @@ nav:
- MQTT Namespace: references/mqtt-namespace.md
- Javadoc: references/javadoc.md
- REST-APIs:
- Configuration V1: references/rest-apis/rest-configuration-service-v1.md
- Configuration V2: references/rest-apis/rest-configuration-service-v2.md
- Cloud Connection: references/rest-apis/rest-cloudconnection-api.md
- Command: references/rest-apis/rest-command-api.md
- Deploy: references/rest-apis/rest-deploy-api.md
Expand Down

0 comments on commit b80937c

Please sign in to comment.