Alignment of Pagination Datatype - #698
Merged
Merged
Conversation
tlohmar
requested review from
PedroDiez,
bigludo7,
eric-murray,
jlurien and
rartych
as code owners
August 11, 2026 07:55
eric-murray
previously approved these changes
Aug 11, 2026
hdamker
requested changes
Aug 24, 2026
Collaborator
There was a problem hiding this comment.
See suggestion below ... instead of adding about 27 lines I suggest to delete 13 lines. We should avoid to repeat definitions from CAMARA_common.yaml verbatim going forward, and we should encourage API authors in the examples to use refs instead of local definitions.
hdamker
reviewed
Aug 24, 2026
Comment on lines
+648
to
+690
| Pagination: | ||
| description: Pagination details helping to navigate through paged results efficiently. | ||
| type: object | ||
| properties: | ||
| page: | ||
| type: integer | ||
| minimum: 1 | ||
| $ref: "#/components/schemas/Page" | ||
| perPage: | ||
| type: integer | ||
| minimum: 1 | ||
| maximum: 100 | ||
| $ref: "#/components/schemas/PerPage" | ||
| totalCount: | ||
| type: integer | ||
| minimum: 0 | ||
| $ref: "#/components/schemas/TotalCount" | ||
| totalPages: | ||
| type: integer | ||
| minimum: 0 | ||
| $ref: "#/components/schemas/TotalPages" | ||
|
|
||
| Page: | ||
| type: integer | ||
| format: int32 | ||
| minimum: 1 | ||
| maximum: 2147483647 | ||
| default: 1 | ||
| description: Current page number (1-indexed). | ||
| example: 1 | ||
| PerPage: | ||
| type: integer | ||
| format: int32 | ||
| minimum: 1 | ||
| maximum: 100 | ||
| default: 20 | ||
| description: Number of items per page. | ||
| example: 20 | ||
| TotalCount: | ||
| type: integer | ||
| format: int32 | ||
| minimum: 0 | ||
| maximum: 2147483647 | ||
| description: Total number of items matching the query, after filters applied. MAY be omitted where a full count query is prohibitively expensive. | ||
| example: 87 | ||
| TotalPages: | ||
| type: integer | ||
| format: int32 | ||
| minimum: 0 | ||
| maximum: 2147483647 | ||
| description: Total number of pages. Equals ceil(totalCount / perPage). MAY be omitted where totalCount is omitted. | ||
| example: 5 |
Collaborator
There was a problem hiding this comment.
Once pagination refs CAMARA_common.yaml above, this local copy of Pagination/Page/PerPage/TotalCount/TotalPages should be removed — nothing points to it.
Contributor
Author
Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
hdamker
approved these changes
Aug 27, 2026
eric-murray
approved these changes
Sep 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What this PR does / why we need it:
The PR aligns the Pagination Datatype definition in the example to CAMARA_common.yaml.
Which issue(s) this PR fixes:
Fixes #696
Does this PR introduce a breaking change?
Special notes for reviewers:
Changelog input
Additional documentation
This section can be blank.