Skip to content

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

Closed
kuudori wants to merge 1 commit into
mainfrom
HYPERFLEET-1282-pagination-breaking-change-doc
Closed

HYPERFLEET-1282: Document pageSize→size / orderBy→order breaking change#2
kuudori wants to merge 1 commit into
mainfrom
HYPERFLEET-1282-pagination-breaking-change-doc

Conversation

@kuudori

@kuudori kuudori commented Jun 25, 2026

Copy link
Copy Markdown
Owner

Jira

HYPERFLEET-1282 · Epic: HYPERFLEET-1272

What

Adds breaking-change checklist entry openshift-hyperfleet#5 for the pagination query parameter rename (pageSizesize, orderByorder) 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 openshift-hyperfleet#5 in API Contract table
2 Documents old vs new parameter names Change column: pageSizesize, orderByorder
3 Includes impact on clients and compatibility Partner Action + Impact if Missed columns

Changes

Verification

  • "Impact if Missed" confirmed: pkg/services/types.go in hyperfleet-api PR #253 (merged) 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).

@kuudori kuudori closed this Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant