From 99f0717c94a489ee40b33e35a33ba41d715d2385 Mon Sep 17 00:00:00 2001 From: Rafael Benevides Date: Wed, 24 Jun 2026 09:49:12 -0300 Subject: [PATCH] =?UTF-8?q?HYPERFLEET-1272=20-=20refactor:=20rename=20quer?= =?UTF-8?q?y=20params=20pageSize=E2=86=92size=20and=20orderBy=E2=86=92orde?= =?UTF-8?q?r?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Aligns with api.openshift.com conventions. Removes unused OrderDirection enum and separate order direction parameter. Bumps version to 1.0.24. --- CHANGELOG.md | 12 +++++++++++ main.tsp | 2 +- package.json | 2 +- schemas/core/openapi.yaml | 39 +++++++++------------------------- shared/models/common/model.tsp | 12 ++--------- 5 files changed, 26 insertions(+), 41 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9c1bba3..45ae28b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [1.0.24] - 2026-06-24 + +### Changed + +- Rename `pageSize` query parameter to `size` (HYPERFLEET-1272) +- Rename `orderBy` query parameter to `order` (HYPERFLEET-1272) + +### Removed + +- `OrderDirection` enum (unused; direction is encoded in the `order` string parameter) +- Separate `order?: OrderDirection` query parameter (absorbed by renamed `order` string parameter) + ## [1.0.23] - 2026-06-22 ### Changed diff --git a/main.tsp b/main.tsp index 8ef0c8d..bf1c9a3 100644 --- a/main.tsp +++ b/main.tsp @@ -30,7 +30,7 @@ using OpenAPI; */ @service(#{ title: "HyperFleet API" }) @info(#{ - version: "1.0.23", + version: "1.0.24", contact: #{ name: "HyperFleet Team", url: "https://github.com/openshift-hyperfleet", diff --git a/package.json b/package.json index 9ca0f9f..7df66f9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "hyperfleet", - "version": "1.0.23", + "version": "1.0.24", "type": "module", "exports": { "./*": "./*" diff --git a/schemas/core/openapi.yaml b/schemas/core/openapi.yaml index 0077cd0..1a44388 100644 --- a/schemas/core/openapi.yaml +++ b/schemas/core/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: HyperFleet API - version: 1.0.23 + version: 1.0.24 contact: name: HyperFleet Team url: https://github.com/openshift-hyperfleet @@ -30,8 +30,7 @@ paths: parameters: - $ref: '#/components/parameters/SearchParams' - $ref: '#/components/parameters/QueryParams.page' - - $ref: '#/components/parameters/QueryParams.pageSize' - - $ref: '#/components/parameters/QueryParams.orderBy' + - $ref: '#/components/parameters/QueryParams.size' - $ref: '#/components/parameters/QueryParams.order' responses: '200': @@ -387,8 +386,7 @@ paths: type: string - $ref: '#/components/parameters/SearchParams' - $ref: '#/components/parameters/QueryParams.page' - - $ref: '#/components/parameters/QueryParams.pageSize' - - $ref: '#/components/parameters/QueryParams.orderBy' + - $ref: '#/components/parameters/QueryParams.size' - $ref: '#/components/parameters/QueryParams.order' responses: '200': @@ -784,8 +782,7 @@ paths: type: string - $ref: '#/components/parameters/SearchParams' - $ref: '#/components/parameters/QueryParams.page' - - $ref: '#/components/parameters/QueryParams.pageSize' - - $ref: '#/components/parameters/QueryParams.orderBy' + - $ref: '#/components/parameters/QueryParams.size' - $ref: '#/components/parameters/QueryParams.order' responses: '200': @@ -894,8 +891,7 @@ paths: type: string - $ref: '#/components/parameters/SearchParams' - $ref: '#/components/parameters/QueryParams.page' - - $ref: '#/components/parameters/QueryParams.pageSize' - - $ref: '#/components/parameters/QueryParams.orderBy' + - $ref: '#/components/parameters/QueryParams.size' - $ref: '#/components/parameters/QueryParams.order' responses: '200': @@ -992,8 +988,7 @@ paths: parameters: - $ref: '#/components/parameters/SearchParams' - $ref: '#/components/parameters/QueryParams.page' - - $ref: '#/components/parameters/QueryParams.pageSize' - - $ref: '#/components/parameters/QueryParams.orderBy' + - $ref: '#/components/parameters/QueryParams.size' - $ref: '#/components/parameters/QueryParams.order' responses: '200': @@ -1032,8 +1027,7 @@ paths: parameters: - $ref: '#/components/parameters/SearchParams' - $ref: '#/components/parameters/QueryParams.page' - - $ref: '#/components/parameters/QueryParams.pageSize' - - $ref: '#/components/parameters/QueryParams.orderBy' + - $ref: '#/components/parameters/QueryParams.size' - $ref: '#/components/parameters/QueryParams.order' responses: '200': @@ -1333,8 +1327,7 @@ paths: type: string - $ref: '#/components/parameters/SearchParams' - $ref: '#/components/parameters/QueryParams.page' - - $ref: '#/components/parameters/QueryParams.pageSize' - - $ref: '#/components/parameters/QueryParams.orderBy' + - $ref: '#/components/parameters/QueryParams.size' - $ref: '#/components/parameters/QueryParams.order' responses: '200': @@ -1428,13 +1421,6 @@ components: name: order in: query required: false - schema: - $ref: '#/components/schemas/OrderDirection' - explode: false - QueryParams.orderBy: - name: orderBy - in: query - required: false schema: type: string default: created_time @@ -1449,8 +1435,8 @@ components: minimum: 1 default: 1 explode: false - QueryParams.pageSize: - name: pageSize + QueryParams.size: + name: size in: query required: false schema: @@ -2359,11 +2345,6 @@ components: href: type: string description: Resource URI - OrderDirection: - type: string - enum: - - asc - - desc ProblemDetails: type: object required: diff --git a/shared/models/common/model.tsp b/shared/models/common/model.tsp index 852cc26..88a4238 100644 --- a/shared/models/common/model.tsp +++ b/shared/models/common/model.tsp @@ -175,11 +175,6 @@ model Page { items: Kind[]; } -enum OrderDirection { - asc, - desc, -} - model SearchParams { /** Filter results using TSL (Tree Search Language) query syntax. * Examples: `status.conditions.Reconciled='True'`, `name in ('c1','c2')`, `labels.region='us-east'` */ @@ -195,13 +190,10 @@ model QueryParams { @query @minValue(1) - pageSize?: int32 = 20; - - @query - orderBy?: string = "created_time"; + size?: int32 = 20; @query - order?: OrderDirection; + order?: string = "created_time"; } model List {