HYPERFLEET-1282: Document pageSize→size / orderBy→order breaking change

[kuudori]

Jira

HYPERFLEET-1282 · Epic: HYPERFLEET-1272

What

Adds breaking-change checklist entry #5 for the pagination query parameter rename (pageSize→size, orderBy→order) introduced in HYPERFLEET-1272 and implemented in hyperfleet-api PR #253.

Also updates two stale pageSize=10 benchmark labels in performance-baselines.md.

AC → coverage

#	AC	Addressed by
1	Entry added to hyperfleet/docs/release/v1.0.0/breaking-changes.md	Row #5 in API Contract table
2	Documents old vs new parameter names	Change column: pageSize→size, orderBy→order
3	Includes impact on clients and compatibility	Partner Action + Impact if Missed columns

Changes

• hyperfleet/docs/release/v1.0.0/breaking-changes.md — insert row chore : update readme to capture more details of the repo #5 (pagination rename) in API Contract table; renumber downstream rows chore : update readme to capture more details of the repo #5-17 → DO NOT MERGE ; Example status swagger #6-18 (one inline #9 ref updated to #10)
• hyperfleet/docs/performance-baselines.md — update two benchmark labels pageSize=10 → size=10

Verification

• "Impact if Missed" confirmed: pkg/services/types.go in hyperfleet-api PR #253 reads only params.Get("size") / params.Get("order"); old names silently fall to defaults (page=1, size=20, no ordering)
• npx markdownlint-cli2: 0 errors
• Base: c13125f (main, up to date)

E2E

Gated in CI, not run locally (documentation-only change).

[openshift-ci-robot]

@kuudori: This pull request references HYPERFLEET-1282 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "5.0.0" version, but no target version was set.

Details

In response to this:

Jira

HYPERFLEET-1282 · Epic: HYPERFLEET-1272

What

Adds breaking-change checklist entry #5 for the pagination query parameter rename (pageSize→size, orderBy→order) introduced in HYPERFLEET-1272 and implemented in hyperfleet-api PR #253.

Also updates two stale pageSize=10 benchmark labels in performance-baselines.md.

AC → coverage

#	AC	Addressed by
1	Entry added to hyperfleet/docs/release/v1.0.0/breaking-changes.md	Row #5 in API Contract table
2	Documents old vs new parameter names	Change column: pageSize→size, orderBy→order
3	Includes impact on clients and compatibility	Partner Action + Impact if Missed columns

Changes

• hyperfleet/docs/release/v1.0.0/breaking-changes.md — insert row chore : update readme to capture more details of the repo #5 (pagination rename) in API Contract table; renumber downstream rows chore : update readme to capture more details of the repo #5-17 → DO NOT MERGE ; Example status swagger #6-18 (one inline #9 ref updated to #10)
• hyperfleet/docs/performance-baselines.md — update two benchmark labels pageSize=10 → size=10

Verification

• "Impact if Missed" confirmed: pkg/services/types.go in hyperfleet-api PR #253 reads only params.Get("size") / params.Get("order"); old names silently fall to defaults (page=1, size=20, no ordering)
• npx markdownlint-cli2: 0 errors
• Base: c13125f (main, up to date)

E2E

Gated in CI, not run locally (documentation-only change).

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[openshift-ci-robot]

@kuudori: This pull request references HYPERFLEET-1282 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "5.0.0" version, but no target version was set.

Details

In response to this:

Jira

HYPERFLEET-1282 · Epic: HYPERFLEET-1272

What

Adds breaking-change checklist entry #5 for the pagination query parameter rename (pageSize→size, orderBy→order) introduced in HYPERFLEET-1272 and implemented in hyperfleet-api PR #253.

Also updates two stale pageSize=10 benchmark labels in performance-baselines.md.

AC → coverage

#	AC	Addressed by
1	Entry added to hyperfleet/docs/release/v1.0.0/breaking-changes.md	Row #5 in API Contract table
2	Documents old vs new parameter names	Change column: pageSize→size, orderBy→order
3	Includes impact on clients and compatibility	Partner Action + Impact if Missed columns

Changes

• hyperfleet/docs/release/v1.0.0/breaking-changes.md — insert row chore : update readme to capture more details of the repo #5 (pagination rename) in API Contract table; renumber downstream rows chore : update readme to capture more details of the repo #5-17 → DO NOT MERGE ; Example status swagger #6-18 (one inline #9 ref updated to #10)
• hyperfleet/docs/performance-baselines.md — update two benchmark labels pageSize=10 → size=10

Verification

• "Impact if Missed" confirmed: pkg/services/types.go in hyperfleet-api PR #253 reads only params.Get("size") / params.Get("order"); old names silently fall to defaults (page=1, size=20, no ordering)
• npx markdownlint-cli2: 0 errors
• Base: c13125f (main, up to date)

E2E

Gated in CI, not run locally (documentation-only change).

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: bb6169c3-4e06-42ee-821c-f3e4066f0322

📥 Commits

Reviewing files that changed from the base of the PR and between c13125f and 358358c.

📒 Files selected for processing (2)

• hyperfleet/docs/performance-baselines.md
• hyperfleet/docs/release/v1.0.0/breaking-changes.md

🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

• openshift-hyperfleet/architecture (manual)
• openshift-hyperfleet/hyperfleet-api (manual)
• openshift-hyperfleet/hyperfleet-sentinel (manual)
• openshift-hyperfleet/hyperfleet-adapter (manual)
• openshift-hyperfleet/hyperfleet-broker (manual)

---

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Updated performance baseline examples to use the size pagination parameter for API list requests.
  • Added a new breaking-change checklist item noting pagination parameter renames for list endpoints.
  • Refreshed the release notes date and renumbered related checklist items for consistency.

Walkthrough

Updated the breaking-changes document timestamp, added a v1.0.0 checklist entry for renaming list-endpoint pagination parameters from pageSize to size and orderBy to order, and changed the /clusters API reads baseline examples to use size-based query strings with unchanged measurements.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 11

✅ Passed checks (11 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately names the documented pagination parameter rename, which is the primary change in the PR.
Description check	✅ Passed	The description directly explains the documentation updates and matches the breaking-change entry and benchmark label edits.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Sec-02: Secrets In Log Output	✅ Passed	Docs-only diff; no slog/logr/zap/fmt.Print* secret-bearing fields or interpolations found. CWE-532 not present.
No Hardcoded Secrets	✅ Passed	No hardcoded credentials, embedded creds, or long base64 strings found in the changed docs; only benchmark label and checklist text were edited (CWE-798/CWE-321).
No Weak Cryptography	✅ Passed	Docs-only edit; the touched files contain no md5/des/rc4/SHA1/ECB or secret-comparison code, so no CWE-327/CWE-328 issue.
No Injection Vectors	✅ Passed	PASS: Base..HEAD touches only two markdown docs; scans found no SQL/exec/template.HTML/yaml.Unmarshal injection patterns (CWE-89/78/79/502).
No Privileged Containers	✅ Passed	Only docs changed; no Kubernetes/OpenShift manifests, Helm templates, or Dockerfiles were modified, so no privileged-container setting is in scope.
No Pii Or Sensitive Data In Logs	✅ Passed	PASS: Only Markdown docs changed; no slog/logr/zap/fmt.Print logging statements or log payloads appear in the touched files, so no CWE-532 risk introduced.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

✨ Simplify code

• Create PR with simplified code

---

_{Comment @coderabbitai help to get the list of available commands.}

[ldornele]

Severity: nit

Suggested fix:

Add API: prefix to the title for clarity:

| 5 | **API: Pagination query parameters renamed: `pageSize` → `size`, `orderBy` → `order`** |

This:

• Makes it explicit this is a REST API contract change
• Follows the component-prefix pattern of rows 6-9
• Helps readers quickly scan which changes affect each component

[ldornele]

Severity: nit

The title uses arrow notation → for parameter renaming, but the document has mixed patterns for expressing transitions

Suggested fix:

For consistency with row 3's "renamed to" pattern:

| 5 | **... query parameters renamed: `pageSize` to `size`, `orderBy` to `order`** |

[ldornele]

Severity: nit

Inline JIRA reference HYPERFLEET-1279 in the "Partner Action" column is not hyperlinked, while other columns consistently provide clickable links to JIRA tickets.

Hyperlink the inline ticket reference for consistency:

regenerate after the spec update in [HYPERFLEET-1279](https://redhat.atlassian.net/browse/HYPERFLEET-1279)

This maintains the pattern of always providing clickable links for JIRA tickets mentioned in the document.

[rh-amarin]

/lgtm

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rh-amarin

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [rh-amarin]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment