Browse Source

Updated documentation to mention pagination

master
Jim Martens 10 months ago
parent
commit
b598225538
  1. 24
      oparl-server/src/main/java/de/twomartens/oparlservice/control/OParlController.java

24
oparl-server/src/main/java/de/twomartens/oparlservice/control/OParlController.java

@ -42,7 +42,7 @@ public class OParlController {
@GetMapping(value = {"/body/{id}/agendaItems", "/body/{id}/agendaItems/{pageNumber}"})
@Operation(summary = "List of all agenda items in body",
description = "returns a list of all agenda items in requested body", responses = {
description = "returns a paginated list of all agenda items in requested body", responses = {
@ApiResponse(description = "Successful Operation", responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ObjectList.ObjectListAgendaItem.class))),
@ApiResponse(responseCode = "404", description = "Not found", content = @Content(mediaType = "application/json",
@ -111,7 +111,7 @@ public class OParlController {
@GetMapping(value = {"/body/{id}/consultations", "/body/{id}/consultations/{pageNumber}"})
@Operation(summary = "List of all consultations in body",
description = "returns a list of all consultations in requested body", responses = {
description = "returns a paginated list of all consultations in requested body", responses = {
@ApiResponse(description = "Successful Operation", responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ObjectList.ObjectListConsultation.class))),
@ApiResponse(responseCode = "404", description = "Not found", content = @Content(mediaType = "application/json",
@ -152,7 +152,7 @@ public class OParlController {
@GetMapping(value = {"/body/{id}/files", "/body/{id}/files/{pageNumber}"})
@Operation(summary = "List of all files in body",
description = "returns a list of all files in requested body", responses = {
description = "returns a paginated list of all files in requested body", responses = {
@ApiResponse(description = "Successful Operation", responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ObjectList.ObjectListFile.class))),
@ApiResponse(responseCode = "404", description = "Not found", content = @Content(mediaType = "application/json",
@ -192,7 +192,7 @@ public class OParlController {
}
@GetMapping(value = {"/body/{id}/legislativeTerms", "/body/{id}/legislativeTerms/{pageNumber}"})
@Operation(summary = "List of all legislative terms of a body", description = "returns a list of all legislative terms of requested body", responses = {
@Operation(summary = "List of all legislative terms of a body", description = "returns a paginated list of all legislative terms of requested body", responses = {
@ApiResponse(description = "Successful Operation", responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ObjectList.ObjectListLegislativeTerm.class))),
@ApiResponse(responseCode = "404", description = "Not found", content = @Content(mediaType = "application/json",
@ -233,7 +233,7 @@ public class OParlController {
@GetMapping(value = {"/body/{id}/locations", "/body/{id}/locations/{pageNumber}"})
@Operation(summary = "List of all locations in body",
description = "returns a list of all locations in requested body", responses = {
description = "returns a paginated list of all locations in requested body", responses = {
@ApiResponse(description = "Successful Operation", responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ObjectList.ObjectListLocation.class))),
@ApiResponse(responseCode = "404", description = "Not found", content = @Content(mediaType = "application/json",
@ -274,7 +274,7 @@ public class OParlController {
@GetMapping(value = {"/body/{id}/meetings", "/body/{id}/meetings/{pageNumber}"})
@Operation(summary = "List of all meetings in body",
description = "returns a list of all meetings in requested body", responses = {
description = "returns a paginated list of all meetings in requested body", responses = {
@ApiResponse(description = "Successful Operation", responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ObjectList.ObjectListMeeting.class))),
@ApiResponse(responseCode = "404", description = "Not found", content = @Content(mediaType = "application/json",
@ -298,7 +298,7 @@ public class OParlController {
@GetMapping(value = {"/organization/{id}/meetings", "/organization/{id}/meetings/{pageNumber}"})
@Operation(summary = "List of all meetings in organization",
description = "returns a list of all meetings in requested organization", responses = {
description = "returns a paginated list of all meetings in requested organization", responses = {
@ApiResponse(description = "Successful Operation", responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ObjectList.ObjectListMeeting.class))),
@ApiResponse(responseCode = "404", description = "Not found", content = @Content(mediaType = "application/json",
@ -338,7 +338,7 @@ public class OParlController {
}
@GetMapping(value = {"/body/{id}/memberships", "/body/{id}/memberships/{pageNumber}"})
@Operation(summary = "List of all memberships in body", description = "returns a list of all memberships in requested body", responses = {
@Operation(summary = "List of all memberships in body", description = "returns a paginated list of all memberships in requested body", responses = {
@ApiResponse(description = "Successful Operation", responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ObjectList.ObjectListMembership.class))),
@ApiResponse(responseCode = "404", description = "Not found", content = @Content(mediaType = "application/json",
@ -362,7 +362,7 @@ public class OParlController {
@GetMapping(value = {"/organization/{id}/memberships", "/organization/{id}/memberships/{pageNumber}"})
@Operation(summary = "List of all memberships in organization",
description = "returns a list of all memberships in requested organization", responses = {
description = "returns a paginated list of all memberships in requested organization", responses = {
@ApiResponse(description = "Successful Operation", responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ObjectList.ObjectListMembership.class))),
@ApiResponse(responseCode = "404", description = "Not found", content = @Content(mediaType = "application/json",
@ -411,7 +411,7 @@ public class OParlController {
}
@GetMapping(value = {"/body/{id}/organizations", "/body/{id}/organizations/{pageNumber}"})
@Operation(summary = "List of all organizations in body", description = "returns a list of all organizations in requested body", responses = {
@Operation(summary = "List of all organizations in body", description = "returns a paginated list of all organizations in requested body", responses = {
@ApiResponse(description = "Successful Operation", responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ObjectList.ObjectListOrganization.class))),
@ApiResponse(responseCode = "404", description = "Not found", content = @Content(mediaType = "application/json",
@ -452,7 +452,7 @@ public class OParlController {
@GetMapping(value = {"/body/{id}/papers", "/body/{id}/papers/{pageNumber}"})
@Operation(summary = "List of all papers in body",
description = "returns a list of all papers in requested body", responses = {
description = "returns a paginated list of all papers in requested body", responses = {
@ApiResponse(description = "Successful Operation", responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ObjectList.ObjectListPaper.class))),
@ApiResponse(responseCode = "404", description = "Not found", content = @Content(mediaType = "application/json",
@ -492,7 +492,7 @@ public class OParlController {
}
@GetMapping(value = {"/body/{id}/persons", "/body/{id}/persons/{pageNumber}"})
@Operation(summary = "List of all persons in body", description = "returns a list of all persons in requested body", responses = {
@Operation(summary = "List of all persons in body", description = "returns a paginated list of all persons in requested body", responses = {
@ApiResponse(description = "Successful Operation", responseCode = "200",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ObjectList.ObjectListPerson.class))),
@ApiResponse(responseCode = "404", description = "Not found", content = @Content(mediaType = "application/json",

Loading…
Cancel
Save