Missing pagination parameters in OpenAPI specification

[danielkelemen]

Environment (Required on creation)

All supported versions. Support case mentioned 7.18 and 7.19.

Description (Required on creation; please attach any relevant screenshots, stacktraces, log files, etc. to the ticket)

Pagination parameters (firstResult, maxResults) are missing for /history/incident in our OpenAPI specification. REST API supports them.

Steps to reproduce (Required on creation)

Check out the OpenAPI spec (or download it) for /history/incident.

Observed Behavior (Required on creation)

Pagination parameters are missing.

Expected behavior (Required on creation)

Pagination parameters are included.

Root Cause (Required on prioritization)

Pagination params need to be added in the specification.

Solution Ideas

Add <#include "/lib/commons/pagination-params.ftl" >.

Hints

Check the other APIs, if they also lack these parameters.

Links

• https://jira.camunda.com/browse/SUPPORT-18168

Breakdown

### Pull Requests
- [ ] https://github.com/camunda/camunda-bpm-platform/pull/3825
- [ ] https://github.com/camunda/camunda-bpm-platform-maintenance/pull/1086
- [ ] https://github.com/camunda/camunda-bpm-platform-maintenance/pull/1087
- [ ] https://github.com/camunda/camunda-bpm-platform-maintenance/pull/1088
- [ ] https://github.com/camunda/camunda-docs-manual/pull/1551

Dev2QA handover

• [ ] Does this ticket need a QA test and the testing goals are not clear from the description? Add a Dev2QA handover comment

[yanavasileva]

Returning for implementing review hints.

@mboskamp 🔧 On version 7.18 the Rest docs are still in docs-manual, therefore the pagination parameters won't be picked up automatically from the OpenAPI and they are missing there as well:

• https://docs.camunda.org/manual/7.18/reference/rest/history/incident/get-incident-query/#query-parameters We can consider adding them.

[mboskamp]

I realized that some POST count endpoints have non-supported and nonsensical pagination and sorting parameters introduced by accident because we use inheritance for the DTO templates. I will try to introduce parameters to the templates that control whether or not to include pagination and/or sorting options.

Edit: This is out of scope for now. I created https://github.com/camunda/camunda-bpm-platform/issues/3878 to track this issue separately.

[yanavasileva]

Review done, thank you for following the review hints!