Skip to content

Commit

Permalink
feat(rest):Components with all details Rest Api doc updated
Browse files Browse the repository at this point in the history
Signed-off-by: Muhammad Ali <alimuhammad@siemens.com>
  • Loading branch information
muhammadali9699 committed May 3, 2023
1 parent 1591b8b commit 9173e07
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions rest/resource-server/src/docs/asciidoc/components.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 9173e07

Please sign in to comment.