From 9173e079803751cd73164bebe3e355ec033a18cc Mon Sep 17 00:00:00 2001 From: Muhammad Ali Date: Tue, 2 May 2023 21:13:20 -0700 Subject: [PATCH] feat(rest):Components with all details Rest Api doc updated Signed-off-by: Muhammad Ali --- .../src/docs/asciidoc/components.adoc | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/rest/resource-server/src/docs/asciidoc/components.adoc b/rest/resource-server/src/docs/asciidoc/components.adoc index fabe86e57d..305edfad49 100644 --- a/rest/resource-server/src/docs/asciidoc/components.adoc +++ b/rest/resource-server/src/docs/asciidoc/components.adoc @@ -31,6 +31,28 @@ include::{snippets}/should_document_get_components/http-response.adoc[] ===== Links include::{snippets}/should_document_get_components/links.adoc[] +[[resources-components-list]] +==== Listing components with all details + +A `GET` request will list all of the service's components with all details. + +===== Request parameter +include::{snippets}/should_document_get_components_with_all_details/request-parameters.adoc[] + +===== Response structure +include::{snippets}/should_document_get_components_with_all_details/response-fields.adoc[] + +===== Example request +include::{snippets}/should_document_get_components_with_all_details/curl-request.adoc[] + +===== Example response +include::{snippets}/should_document_get_components_with_all_details/http-response.adoc[] + +===== Links +include::{snippets}/should_document_get_components_with_all_details/links.adoc[] + + + [[resources-recent-components-list]] ==== Listing recent components