diff --git a/spec/endpoints/destinations/index.yaml b/spec/endpoints/destinations/index.yaml index c6ac99598e4bd0ed428f493a162503b704cdc3da..e2ea21b52bae76f9c4f37b631f4fc20aba9799d5 100644 --- a/spec/endpoints/destinations/index.yaml +++ b/spec/endpoints/destinations/index.yaml @@ -8,6 +8,9 @@ get: - OAuth2: - 'subscribe:destination:<id>' - 'manage:destination:<id>' + parameters: + - $ref: '../../parameters/pagination/limit.yaml' + - $ref: '../../parameters/pagination/offset.yaml' responses: '200': description: OK diff --git a/spec/endpoints/submissions/events/index.yaml b/spec/endpoints/submissions/events/index.yaml index 6f20be9bfbda7ff107a4248f5234c078cdb4f14b..4c3fa793a0b3b2662c89f1e54c5865ed499c5f64 100644 --- a/spec/endpoints/submissions/events/index.yaml +++ b/spec/endpoints/submissions/events/index.yaml @@ -16,6 +16,9 @@ get: - 'manage:destination:<id>' - 'send:region:DE<region-id>+send:service:<service-uri>' - 'send:region:DE<region-id>' + parameters: + - $ref: '../../../parameters/pagination/limit.yaml' + - $ref: '../../../parameters/pagination/offset.yaml' responses: '200': description: OK diff --git a/spec/endpoints/submissions/index.yaml b/spec/endpoints/submissions/index.yaml index a75097f0ff53aaa0bbf1b68a83bc68b23d6c0372..49cddbd0ee384feab150b2e9a18b0c78f5adbf4a 100644 --- a/spec/endpoints/submissions/index.yaml +++ b/spec/endpoints/submissions/index.yaml @@ -9,6 +9,8 @@ get: - 'subscribe:destination:<id>' parameters: - $ref: '../../parameters/destinationIdInQuery.yaml' + - $ref: '../../parameters/pagination/limit.yaml' + - $ref: '../../parameters/pagination/offset.yaml' responses: '200': description: OK diff --git a/spec/parameters/pagination/limit.yaml b/spec/parameters/pagination/limit.yaml new file mode 100644 index 0000000000000000000000000000000000000000..73f0dc2db89cb94c1bf01a1fbb423d583c8d601c --- /dev/null +++ b/spec/parameters/pagination/limit.yaml @@ -0,0 +1,9 @@ +name: limit +in: query +description: Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500. Standard ist 100. +required: false +schema: + type: integer + format: int32 + minimum: 1 + maximum: 500 diff --git a/spec/parameters/pagination/offset.yaml b/spec/parameters/pagination/offset.yaml new file mode 100644 index 0000000000000000000000000000000000000000..8d2f08ccbeebb56c2cb4239d4403c6858d0fb7a8 --- /dev/null +++ b/spec/parameters/pagination/offset.yaml @@ -0,0 +1,8 @@ +name: offset +in: query +description: Startposition der Teilmenge der Ergebnismenge. Standard ist 0. +required: false +schema: + type: integer + format: int32 + minimum: 0 diff --git a/spec/submission-api.yaml b/spec/submission-api.yaml index 726f0a09045c7150af7b07bd2ac0ae7d113bcd63..77d466b9f047bb7a036538c3f9b030414bebd080 100644 --- a/spec/submission-api.yaml +++ b/spec/submission-api.yaml @@ -75,6 +75,10 @@ components: $ref: './parameters/destinationIdInQuery.yaml' attachmentId: $ref: './parameters/attachmentId.yaml' + limit: + $ref: './parameters/pagination/limit.yaml' + offset: + $ref: './parameters/pagination/offset.yaml' schemas: Submission: