From 00bb8b2a6e4e530c539955aaadfde07d1d139d7c Mon Sep 17 00:00:00 2001 From: Angel Marin Date: Thu, 25 Jun 2026 11:41:09 +0200 Subject: [PATCH] HYPERFLEET-1272 - feat: rename query string params --- main.tsp | 2 +- package-lock.json | 13 ++++-- package.json | 2 +- schemas/template/openapi.yaml | 49 +++++++++---------- schemas/template/swagger.yaml | 88 +++++++++-------------------------- 5 files changed, 57 insertions(+), 97 deletions(-) diff --git a/main.tsp b/main.tsp index 2dec215..61d493c 100644 --- a/main.tsp +++ b/main.tsp @@ -33,7 +33,7 @@ using OpenAPI; */ @service(#{ title: "HyperFleet API" }) @info(#{ - version: "1.0.24", + version: "1.0.25", contact: #{ name: "HyperFleet Team", url: "https://github.com/openshift-hyperfleet", diff --git a/package-lock.json b/package-lock.json index cf32b3a..cb01745 100644 --- a/package-lock.json +++ b/package-lock.json @@ -8,7 +8,7 @@ "name": "hyperfleet-template-api-spec", "version": "1.0.15", "dependencies": { - "hyperfleet": "github:openshift-hyperfleet/hyperfleet-api-spec#main" + "hyperfleet": "github:openshift-hyperfleet/hyperfleet-api-spec#v1.0.24" }, "devDependencies": { "@stoplight/spectral-cli": "6.15.1", @@ -1260,6 +1260,7 @@ "integrity": "sha512-hKCkHEEDdCpXFyOU8ln+TzBBwonFMbkeUV0zIc+vBETyO8p/Upui3XvEyLOyB4CpKUReHzGeGm3gcFjNc73ygg==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@babel/code-frame": "^7.29.0", "@inquirer/prompts": "^8.4.1", @@ -1420,6 +1421,7 @@ "integrity": "sha512-3Bb1M6VSuEVPWOecXj3h3I/ddMpb9cmKRQQq34oq7LatiK4fwVBp+EdWbqzEzaRUGHm9mZtqsMsxZf5FndT8dg==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=22.0.0" }, @@ -1439,6 +1441,7 @@ "integrity": "sha512-XtkCMPpzXFfuIzmx/BQrCMUCCk7d37lkqZe5ubJmvJ02Fr7yvAbofrgtNUZ1BbFe3TBBUS2nB3E3mjT3tE4zCQ==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=22.0.0" }, @@ -1517,6 +1520,7 @@ "integrity": "sha512-s8giuYQTQPniy2YxNfKXYpAU2Vm4L74TdOsbFWe0tG+jnOy/9tt7kKTH4QF1sB8nRvmjv8h31EoHtZYOPe1GvA==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=22.0.0" }, @@ -1551,6 +1555,7 @@ "integrity": "sha512-Thbli+OlOj+iMPYFBVBfJ3OmCAnaSyNn4M1vz9T6Gka5Jt9ba/HIR56joy65tY6kx/FCF5VXNB819Y7/GUrBGA==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", @@ -3901,8 +3906,8 @@ "license": "MIT" }, "node_modules/hyperfleet": { - "version": "1.0.20", - "resolved": "git+ssh://git@github.com/openshift-hyperfleet/hyperfleet-api-spec.git#64f50064ce06384e0d368622126699447ec4e998" + "version": "1.0.24", + "resolved": "git+ssh://git@github.com/openshift-hyperfleet/hyperfleet-api-spec.git#e527445ac7261e1a6acccd36e51936b68b23e00e" }, "node_modules/iconv-lite": { "version": "0.7.2", @@ -4637,6 +4642,7 @@ "integrity": "sha512-B7qPcEVE3NVkmSJbaYxvv4cHkVW7DQsZz13pUMrfS8z8Q/BuShN+gcTXrUlPiGqM2/t/EEaI030bpxMqY8gMlw==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">= 10.16.0" } @@ -6291,6 +6297,7 @@ "integrity": "sha512-cIFJOD1DESzpjOBl763Kp1AH7UE/0fcdHe6rZXUdQ9c50uvgigvW97u3IcSeBwOkgqL/PXPBktBCh0KEu5L8XQ==", "dev": true, "license": "MIT", + "peer": true, "bin": { "rollup": "dist/bin/rollup" }, diff --git a/package.json b/package.json index b823517..626be63 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "build": "./build-schema.sh" }, "dependencies": { - "hyperfleet": "github:openshift-hyperfleet/hyperfleet-api-spec#main" + "hyperfleet": "github:openshift-hyperfleet/hyperfleet-api-spec#v1.0.24" }, "devDependencies": { "@stoplight/spectral-cli": "6.15.1", diff --git a/schemas/template/openapi.yaml b/schemas/template/openapi.yaml index 4bcfa02..1542f65 100644 --- a/schemas/template/openapi.yaml +++ b/schemas/template/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: HyperFleet API - version: 1.0.24 + version: 1.0.25 contact: name: HyperFleet Team url: https://github.com/openshift-hyperfleet @@ -29,8 +29,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': @@ -239,8 +238,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': @@ -463,8 +461,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': @@ -782,8 +779,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': @@ -1124,8 +1120,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': @@ -1164,8 +1159,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': @@ -1367,13 +1361,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 @@ -1388,8 +1375,8 @@ components: minimum: 1 default: 1 explode: false - QueryParams.pageSize: - name: pageSize + QueryParams.size: + name: size in: query required: false schema: @@ -1473,6 +1460,7 @@ components: Channel: type: object required: + - kind - name - spec - created_time @@ -1553,6 +1541,7 @@ components: ChannelCreateRequest: type: object required: + - kind - name - spec properties: @@ -1638,6 +1627,7 @@ components: Cluster: type: object required: + - kind - name - spec - created_time @@ -1770,6 +1760,7 @@ components: ClusterCreateRequest: type: object required: + - kind - name - spec properties: @@ -2001,6 +1992,7 @@ components: NodePool: type: object required: + - kind - name - spec - created_time @@ -2140,6 +2132,7 @@ components: NodePoolCreateRequest: type: object required: + - kind - name - spec properties: @@ -2194,6 +2187,7 @@ components: NodePoolCreateResponse: type: object required: + - kind - name - spec - created_time @@ -2407,6 +2401,8 @@ components: trace_id: deadbeef12345678 ObjectReference: type: object + required: + - kind properties: id: type: string @@ -2417,11 +2413,6 @@ components: href: type: string description: Resource URI - OrderDirection: - type: string - enum: - - asc - - desc ProblemDetails: type: object required: @@ -2607,6 +2598,7 @@ components: Version: type: object required: + - kind - name - spec - created_time @@ -2694,6 +2686,7 @@ components: VersionCreateRequest: type: object required: + - kind - name - spec properties: @@ -2793,6 +2786,7 @@ components: WifConfig: type: object required: + - kind - name - spec - created_time @@ -2873,6 +2867,7 @@ components: WifConfigCreateRequest: type: object required: + - kind - name - spec properties: diff --git a/schemas/template/swagger.yaml b/schemas/template/swagger.yaml index 40ecfd9..1db851f 100644 --- a/schemas/template/swagger.yaml +++ b/schemas/template/swagger.yaml @@ -17,7 +17,7 @@ info: name: Apache 2.0 url: 'https://www.apache.org/licenses/LICENSE-2.0' title: HyperFleet API - version: 1.0.24 + version: 1.0.25 host: hyperfleet.redhat.com basePath: / schemes: @@ -49,18 +49,11 @@ paths: format: int32 in: query minimum: 1 - name: pageSize + name: size required: false type: integer - default: created_time in: query - name: orderBy - required: false - type: string - - enum: - - asc - - desc - in: query name: order required: false type: string @@ -278,18 +271,11 @@ paths: format: int32 in: query minimum: 1 - name: pageSize + name: size required: false type: integer - default: created_time in: query - name: orderBy - required: false - type: string - - enum: - - asc - - desc - in: query name: order required: false type: string @@ -506,18 +492,11 @@ paths: format: int32 in: query minimum: 1 - name: pageSize + name: size required: false type: integer - default: created_time in: query - name: orderBy - required: false - type: string - - enum: - - asc - - desc - in: query name: order required: false type: string @@ -845,18 +824,11 @@ paths: format: int32 in: query minimum: 1 - name: pageSize + name: size required: false type: integer - default: created_time in: query - name: orderBy - required: false - type: string - - enum: - - asc - - desc - in: query name: order required: false type: string @@ -1188,18 +1160,11 @@ paths: format: int32 in: query minimum: 1 - name: pageSize + name: size required: false type: integer - default: created_time in: query - name: orderBy - required: false - type: string - - enum: - - asc - - desc - in: query name: order required: false type: string @@ -1253,18 +1218,11 @@ paths: format: int32 in: query minimum: 1 - name: pageSize + name: size required: false type: integer - default: created_time in: query - name: orderBy - required: false - type: string - - enum: - - asc - - desc - in: query name: order required: false type: string @@ -1585,6 +1543,7 @@ definitions: format: date-time type: string required: + - kind - name - spec - created_time @@ -1626,6 +1585,7 @@ definitions: spec: $ref: '#/definitions/ChannelSpec' required: + - kind - name - spec type: object @@ -1811,6 +1771,7 @@ definitions: format: date-time type: string required: + - kind - name - spec - created_time @@ -1871,6 +1832,7 @@ definitions: spec: $ref: '#/definitions/ClusterSpec' required: + - kind - name - spec type: object @@ -2202,6 +2164,7 @@ definitions: format: date-time type: string required: + - kind - name - spec - created_time @@ -2263,6 +2226,7 @@ definitions: spec: $ref: '#/definitions/NodePoolSpec' required: + - kind - name - spec type: object @@ -2328,6 +2292,7 @@ definitions: format: date-time type: string required: + - kind - name - spec - created_time @@ -2503,12 +2468,9 @@ definitions: kind: description: Resource kind type: string + required: + - kind type: object - OrderDirection: - enum: - - asc - - desc - type: string ProblemDetails: description: RFC 9457 Problem Details for HTTP APIs example: @@ -2780,6 +2742,7 @@ definitions: format: date-time type: string required: + - kind - name - spec - created_time @@ -2822,6 +2785,7 @@ definitions: spec: $ref: '#/definitions/VersionSpec' required: + - kind - name - spec type: object @@ -2962,6 +2926,7 @@ definitions: format: date-time type: string required: + - kind - name - spec - created_time @@ -3003,6 +2968,7 @@ definitions: spec: $ref: '#/definitions/WifConfigSpec' required: + - kind - name - spec type: object @@ -3070,17 +3036,9 @@ tags: x-components: parameters: QueryParams.order: - enum: - - asc - - desc - in: query - name: order - required: false - type: string - QueryParams.orderBy: default: created_time in: query - name: orderBy + name: order required: false type: string QueryParams.page: @@ -3091,12 +3049,12 @@ x-components: name: page required: false type: integer - QueryParams.pageSize: + QueryParams.size: default: 20 format: int32 in: query minimum: 1 - name: pageSize + name: size required: false type: integer SearchParams: