Add resource collection /rest/v1/actions to Management REST API (#1299)

* Initial commit

Signed-off-by: Stefan Behl <stefan.behl@bosch.io>

* Added filtering by RSQL

Signed-off-by: Stefan Behl <stefan.behl@bosch.io>

* Support for filtering actions by distribution set, target, rollout

* Added REST docs

* Fixed REST docs

* Introduce a config property which allows to disable the actions endpoint

* Introduce representation mode parameter

* Adapt REST docs

* Incorporate review findings

* Adapt REST docs

* Improve unit tests

* Minor improvements

* Fix REST docs

* Fix REST docs

* Fix PR review findings

Signed-off-by: Stefan Behl <stefan.behl@bosch.io>
This commit is contained in:
Stefan Behl
2023-01-10 17:19:05 +01:00
committed by GitHub
parent 27872282f5
commit d7796121d1
19 changed files with 1046 additions and 37 deletions

View File

@@ -0,0 +1,73 @@
:doctype: book
:icons: font
:source-highlighter: highlightjs
:toc: macro
:toclevels: 1
:sectlinks:
:linkattrs:
[[actions]]
= Actions
toc::[]
== GET /rest/v1/actions
=== Implementation notes
Handles the GET request of retrieving all actions within Hawkbit. Required permission: READ_TARGET
=== Get paged list of actions
==== CURL
include::{snippets}/actions/get-actions/curl-request.adoc[]
==== Request URL
A `GET` request is used to access the actions
include::{snippets}/actions/get-actions/http-request.adoc[]
==== Request query parameter
include::{snippets}/actions/get-actions-with-parameters/request-parameters.adoc[]
==== Request parameter example
include::{snippets}/actions/get-actions-with-parameters/http-request.adoc[]
=== Response (Status 200)
==== Response fields
include::{snippets}/actions/get-actions/response-fields.adoc[]
==== Response example
include::{snippets}/actions/get-actions/http-response.adoc[]
==== Response example for representation mode 'full'
include::{snippets}/actions/get-actions-with-parameters/http-response.adoc[]
=== Error responses
|===
| HTTP Status Code | Reason | Response Model
include::../errors/400.adoc[]
include::../errors/401.adoc[]
include::../errors/403.adoc[]
include::../errors/405.adoc[]
include::../errors/406.adoc[]
include::../errors/429.adoc[]
|===
== Additional content
[[error-body]]
=== Error body
include::../errors/error-response-body.adoc[]