Merge pull request #2200 from siemens/docs/api/openapi-releases

docs(api): add OpenAPI docs for releases Reviewed by: hoang2.nguyenthai@toshiba.co.jp Tested by: anupam.ghosh@siemens.com
eclipse-sw360 · Dec 6, 2023 · 55c36b5 · 55c36b5
2 parents c28e372 + 27dc3d8
commit 55c36b5
Show file tree

Hide file tree

Showing 2 changed files with 514 additions and 86 deletions.
diff --git a/rest/resource-server/src/docs/asciidoc/releases.adoc b/rest/resource-server/src/docs/asciidoc/releases.adoc
@@ -257,6 +257,20 @@ include::{snippets}/should_document_get_release_attachment_bundle/curl-request.a
 ===== Example response
 include::{snippets}/should_document_get_release_attachment_bundle/http-response.adoc[]
 
+[[resources-release-external-id]]
+==== Get releases by external IDs
+
+A `GET` request will allow you to get releases by external IDs.
+Put the external ID as query parameter and its value as parameter's value.
+
+===== Example request
+
+include::{snippets}/should_document_get_releases_by_externalIds/curl-request.adoc[]
+
+===== Example response
+
+include::{snippets}/should_document_get_releases_by_externalIds/http-response.adoc[]
+
 [[resources-release-attachment-delete]]
 ==== Delete attachments