Skip to content

Commit

Permalink
dcache-frontend: improve Swagger annotations for release and archiveinfo
Browse files Browse the repository at this point in the history
Motivation:

see https://rb.dcache.org/r/13917/
commit master@7f16ca2ca375bd1bc9b8971572897d348dd06386

Modifcation:

Do the same for `archiveinfo` and `release` payload
descriptions.

Result:

Better annotations for request payload structure.

Target: master
Request: 9.0
Request: 8.2
Patch: https://rb.dcache.org/r/13932/
Requires-notes: no
Acked-by: Tigran
  • Loading branch information
alrossi committed Mar 17, 2023
1 parent b40119c commit ec1ab13
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
Expand Up @@ -128,7 +128,8 @@ public final class ArchiveInfoResources {
@Consumes({MediaType.APPLICATION_JSON})
@Produces(MediaType.APPLICATION_JSON)
public List<ArchiveInfo> getArchiveInfo(
@ApiParam(value = "Array of paths for which to return archive info (file locality).",
@ApiParam(value = "Request structure:\n\n"
+ "**paths** - array of paths for which to return archive info (file locality).",
required = true)
String requestPayload) {

Expand Down
Expand Up @@ -134,7 +134,8 @@ public final class ReleaseResources {
@Produces(MediaType.APPLICATION_JSON)
public Response release(
@PathParam("id") String id,
@ApiParam(value = "Array of file paths to release. If any path does not belong to the "
@ApiParam(value = "Request structure:\n\n"
+ "**paths** - array of paths for files to release. If any path does not belong to the "
+ "stage request corresponding to the id, this request will fail.", required = true)
String requestPayload) {

Expand Down

0 comments on commit ec1ab13

Please sign in to comment.