Skip to content

Commit

Permalink
docs(api): add OpenAPI docs for releases
Browse files Browse the repository at this point in the history
1. Add OpenAPI docs for /releases endpoints.
2. Add the missing AsciiDoc for getting releases by external ID.
3. Replace deprecated exception `HttpMessageNotReadableException` with
`HttpClientErrorException`.

Signed-off-by: Gaurav Mishra <gmishx@gmail.com>
  • Loading branch information
GMishx committed Nov 17, 2023
1 parent 471856d commit be126e7
Show file tree
Hide file tree
Showing 2 changed files with 514 additions and 84 deletions.
14 changes: 14 additions & 0 deletions rest/resource-server/src/docs/asciidoc/releases.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,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

Expand Down
Loading

0 comments on commit be126e7

Please sign in to comment.