docs: Moved Configuration Rest API pages to reference section [backpo…

…rt docs-release-5.4] (#5004) docs: Moved Configuration Rest API pages to reference section (#4993) * Moved Configuration Rest API pages to reference section * docs: added references to REST APIs and MQTT request handlers Signed-off-by: Marcello Martina <[email protected]> --------- Signed-off-by: Marcello Martina <[email protected]> Co-authored-by: Marcello Martina <[email protected]> (cherry picked from commit ccc012c) Co-authored-by: Salvatore Coppola <[email protected]>
eclipse-kura · Nov 20, 2023 · 6593e0a · 6593e0a
1 parent 0638b40
commit 6593e0a
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 8 deletions.
diff --git a/docs/administration/snapshot-management.md b/docs/administration/snapshot-management.md
@@ -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.
 

diff --git a/docs/core-services/configuration-service.md b/docs/core-services/configuration-service.md
@@ -2,7 +2,7 @@
 
 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:
+The ConfigurationService 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)
+- [Configuration v1 REST APIs](../references/rest-apis/rest-configuration-service-v1.md) (deprecated) and [CONF-V1 MQTT Request Handler](../references/mqtt-namespace.md#remote-osgi-configurationadmin-interactions-via-mqtt) (deprecated)
+- [Configuration v2 REST APIs and CONF-V2 MQTT Request Handler](../references/rest-apis/rest-configuration-service-v2.md)
diff --git a/...services/configuration-service-rest-v1.md → ...est-apis/rest-configuration-service-v1.md b/...services/configuration-service-rest-v1.md → ...est-apis/rest-configuration-service-v1.md
diff --git a/...services/configuration-service-rest-v2.md → ...est-apis/rest-configuration-service-v2.md b/...services/configuration-service-rest-v2.md → ...est-apis/rest-configuration-service-v2.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -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
@@ -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