From 6593e0aa820924ba7085b97c825e6073ad0eaa48 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 12:06:04 +0100 Subject: [PATCH] docs: Moved Configuration Rest API pages to reference section [backport 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 --------- Signed-off-by: Marcello Martina Co-authored-by: Marcello Martina (cherry picked from commit ccc012c7ff230de1f1f06f88127a61324c98e59a) Co-authored-by: Salvatore Coppola <83589980+salvatore-coppola@users.noreply.github.com> --- docs/administration/snapshot-management.md | 2 +- docs/core-services/configuration-service.md | 6 +++--- .../rest-apis/rest-configuration-service-v1.md} | 0 .../rest-apis/rest-configuration-service-v2.md} | 0 mkdocs.yml | 7 +++---- 5 files changed, 7 insertions(+), 8 deletions(-) rename docs/{core-services/configuration-service-rest-v1.md => references/rest-apis/rest-configuration-service-v1.md} (100%) rename docs/{core-services/configuration-service-rest-v2.md => references/rest-apis/rest-configuration-service-v2.md} (100%) diff --git a/docs/administration/snapshot-management.md b/docs/administration/snapshot-management.md index 7a7bc09ea67..92809abd127 100644 --- 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 index f3caff67825..984acd6da9f 100644 --- 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) \ No newline at end of file +- [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) \ No newline at end of file diff --git a/docs/core-services/configuration-service-rest-v1.md b/docs/references/rest-apis/rest-configuration-service-v1.md similarity index 100% rename from docs/core-services/configuration-service-rest-v1.md rename to docs/references/rest-apis/rest-configuration-service-v1.md diff --git a/docs/core-services/configuration-service-rest-v2.md b/docs/references/rest-apis/rest-configuration-service-v2.md similarity index 100% rename from docs/core-services/configuration-service-rest-v2.md rename to docs/references/rest-apis/rest-configuration-service-v2.md diff --git a/mkdocs.yml b/mkdocs.yml index ef75b553924..e238a519663 100644 --- 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