From 241576d242cd88e6d264180a69a5e1e9cd282df6 Mon Sep 17 00:00:00 2001 From: Jude Niroshan Date: Fri, 8 Mar 2024 15:33:18 +0100 Subject: [PATCH] fix(orchestrator): add missing query parameter changes for /overview endpoint (#1321) fix: add missing query parameter changes for /overview endpoint --- .../src/auto-generated/api/definition.ts | 34 +++++++++++++++++++ .../src/auto-generated/api/models/schema.ts | 12 +++++++ .../auto-generated/docs/index.adoc/index.adoc | 31 +++++++++++++++++ .../src/openapi/openapi.yaml | 21 ++++++++++++ 4 files changed, 98 insertions(+) diff --git a/plugins/orchestrator-common/src/auto-generated/api/definition.ts b/plugins/orchestrator-common/src/auto-generated/api/definition.ts index a11bd7b00f..9d79a7ca7f 100644 --- a/plugins/orchestrator-common/src/auto-generated/api/definition.ts +++ b/plugins/orchestrator-common/src/auto-generated/api/definition.ts @@ -21,6 +21,40 @@ const OPENAPI = ` "get": { "operationId": "getWorkflowsOverview", "description": "Get a list of workflow overviews", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "number" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "number" + } + }, + { + "name": "orderBy", + "in": "query", + "description": "field name to order the data", + "schema": { + "type": "string" + } + }, + { + "name": "orderDirection", + "in": "query", + "description": "ascending or descending", + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "Success", diff --git a/plugins/orchestrator-common/src/auto-generated/api/models/schema.ts b/plugins/orchestrator-common/src/auto-generated/api/models/schema.ts index 8cfd2112b6..bc88ecc0e7 100644 --- a/plugins/orchestrator-common/src/auto-generated/api/models/schema.ts +++ b/plugins/orchestrator-common/src/auto-generated/api/models/schema.ts @@ -218,6 +218,18 @@ export type external = Record; export interface operations { /** @description Get a list of workflow overviews */ getWorkflowsOverview: { + parameters: { + query?: { + /** @description page number */ + page?: number; + /** @description page size */ + pageSize?: number; + /** @description field name to order the data */ + orderBy?: string; + /** @description ascending or descending */ + orderDirection?: string; + }; + }; responses: { /** @description Success */ 200: { diff --git a/plugins/orchestrator-common/src/auto-generated/docs/index.adoc/index.adoc b/plugins/orchestrator-common/src/auto-generated/docs/index.adoc/index.adoc index 17d5a6e96d..ef5d1620f7 100644 --- a/plugins/orchestrator-common/src/auto-generated/docs/index.adoc/index.adoc +++ b/plugins/orchestrator-common/src/auto-generated/docs/index.adoc/index.adoc @@ -855,6 +855,37 @@ Get a list of workflow overviews +====== Query Parameters + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + +| page +| page number +| - +| null +| + +| pageSize +| page size +| - +| null +| + +| orderBy +| field name to order the data +| - +| null +| + +| orderDirection +| ascending or descending +| - +| null +| + +|=== ===== Return Type diff --git a/plugins/orchestrator-common/src/openapi/openapi.yaml b/plugins/orchestrator-common/src/openapi/openapi.yaml index e288fd8e8e..4ea008a559 100644 --- a/plugins/orchestrator-common/src/openapi/openapi.yaml +++ b/plugins/orchestrator-common/src/openapi/openapi.yaml @@ -13,6 +13,27 @@ paths: get: operationId: getWorkflowsOverview description: Get a list of workflow overviews + parameters: + - name: page + in: query + description: page number + schema: + type: number + - name: pageSize + in: query + description: page size + schema: + type: number + - name: orderBy + in: query + description: field name to order the data + schema: + type: string + - name: orderDirection + in: query + description: ascending or descending + schema: + type: string responses: '200': description: Success