From 12eb934c6cd66ea9431fd88afc91fd73591696fc Mon Sep 17 00:00:00 2001 From: Salvatore Coppola Date: Tue, 21 Nov 2023 15:27:48 +0100 Subject: [PATCH 1/2] Added notes on missing SecurityService and is-debug-enabled method. --- docs/references/rest-apis/rest-security-api.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/references/rest-apis/rest-security-api.md b/docs/references/rest-apis/rest-security-api.md index 73989faf526..0be26897d36 100644 --- a/docs/references/rest-apis/rest-security-api.md +++ b/docs/references/rest-apis/rest-security-api.md @@ -2,6 +2,7 @@ !!! note This API can also be accessed via the RequestHandler with app-id: `SEC-V1`. + The standard Kura distribution doesn't provide a [SecurityService](https://download.eclipse.org/kura/docs/api/5.4.0/apidocs/org/eclipse/kura/security/SecurityService.html) implementation required by this API. The `SecurityRestService` APIs provides methods to manage the system security. @@ -18,7 +19,7 @@ Identities with `rest.security` permissions can access these APIs. ##### Responses - 200 OK status -- 500 Internal Server Error +- 500 Internal Server Error (also returned when no `SecurityService` implementation is provided) #### Reload command line fingerprint @@ -29,11 +30,14 @@ Identities with `rest.security` permissions can access these APIs. ##### Responses - 200 OK status -- 500 Internal Server Error +- 500 Internal Server Error (also returned when no `SecurityService` implementation is provided) ## GET methods -#### Debug enabled +#### Debug enabled +!!! note + + Access to this resource doesn't require the `rest.security` permission. - Description: This method allows you to check whether debug mode is enabled in the system. - Method: GET @@ -47,4 +51,4 @@ Identities with `rest.security` permissions can access these APIs. "enabled":true } ``` -- 500 Internal Server Error +- 500 Internal Server Error (also returned when no `SecurityService` implementation is provided) From aa0f00223fdd6b44314d9976a3bee43ca2422754 Mon Sep 17 00:00:00 2001 From: nicolatimeus Date: Tue, 21 Nov 2023 23:02:00 +0100 Subject: [PATCH 2/2] minor rewording --- docs/references/rest-apis/rest-security-api.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/references/rest-apis/rest-security-api.md b/docs/references/rest-apis/rest-security-api.md index 0be26897d36..1306c4c442e 100644 --- a/docs/references/rest-apis/rest-security-api.md +++ b/docs/references/rest-apis/rest-security-api.md @@ -2,7 +2,8 @@ !!! note This API can also be accessed via the RequestHandler with app-id: `SEC-V1`. - The standard Kura distribution doesn't provide a [SecurityService](https://download.eclipse.org/kura/docs/api/5.4.0/apidocs/org/eclipse/kura/security/SecurityService.html) implementation required by this API. + + This REST API requires a [SecurityService](https://download.eclipse.org/kura/docs/api/5.4.0/apidocs/org/eclipse/kura/security/SecurityService.html) implementation to be registered on the framework, which is not provided by the standard Kura distribution. The `SecurityRestService` APIs provides methods to manage the system security. @@ -19,7 +20,7 @@ Identities with `rest.security` permissions can access these APIs. ##### Responses - 200 OK status -- 500 Internal Server Error (also returned when no `SecurityService` implementation is provided) +- 500 Internal Server Error (also returned when no `SecurityService` implementation is available) #### Reload command line fingerprint @@ -30,7 +31,7 @@ Identities with `rest.security` permissions can access these APIs. ##### Responses - 200 OK status -- 500 Internal Server Error (also returned when no `SecurityService` implementation is provided) +- 500 Internal Server Error (also returned when no `SecurityService` implementation is available) ## GET methods @@ -51,4 +52,4 @@ Identities with `rest.security` permissions can access these APIs. "enabled":true } ``` -- 500 Internal Server Error (also returned when no `SecurityService` implementation is provided) +- 500 Internal Server Error (also returned when no `SecurityService` implementation is available)