poststats/golf-rs-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix round documentation

Browse Source
This commit is contained in:
Brian Long
2024-06-14 16:36:25 -04:00
parent 7dfcc45b2e
commit f853010793
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/main/java/com/poststats/golf/rs/api/EventRoundApi.java
View File

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