fix round documentation

This commit is contained in:
2024-06-14 16:36:25 -04:00
parent 7dfcc45b2e
commit f853010793

View File

@@ -32,8 +32,8 @@ public interface EventRoundApi {
@Path("/rounds/next")
@Produces(Constants.V1_JSON)
@Operation(
summary = "Retrieves limited meta-data about an event.",
description = "Retreives name, location, dates, and other direct meta-data about the specified event."
summary = "Retrieves limited meta-data about the next round in the specified event.",
description = "Retreives name, location, dates, and other direct meta-data about the upcoming round in the specified event."
)
@ApiResponses({
@ApiResponse(responseCode = "200", description = "Success"),
@@ -49,8 +49,8 @@ public interface EventRoundApi {
@Path("/round/{eroundId:[0-9]+}")
@Produces(Constants.V1_JSON)
@Operation(
summary = "Retrieves limited meta-data about an event.",
description = "Retreives name, location, dates, and other direct meta-data about the specified event."
summary = "Retrieves limited meta-data about the specified event round.",
description = "Retreives name, location, dates, and other direct meta-data about the specified event round."
)
@ApiResponses({
@ApiResponse(responseCode = "200", description = "Success"),
@@ -69,8 +69,8 @@ public interface EventRoundApi {
@Path("/rounds")
@Produces(Constants.V1_JSON)
@Operation(
summary = "Retrieves limited meta-data about an event.",
description = "Retreives name, location, dates, and other direct meta-data about the specified event."
summary = "Retrieves limited meta-data about all the rounds in the specified event.",
description = "Retreives name, location, dates, and other direct meta-data about all the rounds in the specified event."
)
@ApiResponses({
@ApiResponse(responseCode = "200", description = "Success"),