From d7dbcb21757bfcfa9d5b5e2d457ee2d239ef7052 Mon Sep 17 00:00:00 2001 From: mike12345567 Date: Tue, 1 Mar 2022 18:42:52 +0000 Subject: [PATCH] Adding a top level script for generating specs, symlinking the openapi yaml and json to top level as well. --- package.json | 1 + packages/server/specs/openapi.json | 4 ---- packages/server/specs/openapi.yaml | 3 --- packages/server/specs/resources/query.js | 5 ----- .../server/src/api/controllers/public/mapping/queries.ts | 6 ++++-- packages/server/src/api/controllers/public/types/openapi.ts | 2 -- specs/openapi.json | 1 + specs/openapi.yaml | 1 + 8 files changed, 7 insertions(+), 16 deletions(-) create mode 120000 specs/openapi.json create mode 120000 specs/openapi.yaml diff --git a/package.json b/package.json index 22f5963bd2..626daf8b51 100644 --- a/package.json +++ b/package.json @@ -44,6 +44,7 @@ "lint:fix": "yarn run lint:fix:ts && yarn run lint:fix:prettier && yarn run lint:fix:eslint", "test:e2e": "lerna run cy:test --stream", "test:e2e:ci": "lerna run cy:ci --stream", + "build:specs": "lerna run specs", "build:docker": "lerna run build:docker && npm run build:docker:proxy:compose && cd hosting/scripts/linux/ && ./release-to-docker-hub.sh $BUDIBASE_RELEASE_VERSION && cd -", "build:docker:proxy": "docker build hosting/proxy -t proxy-service", "build:docker:proxy:compose": "lerna run generate:proxy:compose && npm run build:docker:proxy", diff --git a/packages/server/specs/openapi.json b/packages/server/specs/openapi.json index 51b411cd6e..9ee081eb09 100644 --- a/packages/server/specs/openapi.json +++ b/packages/server/specs/openapi.json @@ -1049,10 +1049,6 @@ } } }, - "info": { - "description": "Extra info from the query in a key-value map, like response times.", - "type": "object" - }, "pagination": { "description": "If pagination is supported, this will contain the bookmark/anchor information for it.", "type": "object" diff --git a/packages/server/specs/openapi.yaml b/packages/server/specs/openapi.yaml index 2d39624aa1..c9b7a38e0d 100644 --- a/packages/server/specs/openapi.yaml +++ b/packages/server/specs/openapi.yaml @@ -762,9 +762,6 @@ components: raw: description: The raw query response, as a string. type: string - info: - description: Extra info from the query in a key-value map, like response times. - type: object pagination: description: If pagination is supported, this will contain the bookmark/anchor information for it. diff --git a/packages/server/specs/resources/query.js b/packages/server/specs/resources/query.js index fa1f59b094..8a0b888024 100644 --- a/packages/server/specs/resources/query.js +++ b/packages/server/specs/resources/query.js @@ -163,11 +163,6 @@ const executeQueryOutputSchema = object( }, }, }, - info: { - description: - "Extra info from the query in a key-value map, like response times.", - type: "object", - }, pagination: { description: "If pagination is supported, this will contain the bookmark/anchor information for it.", diff --git a/packages/server/src/api/controllers/public/mapping/queries.ts b/packages/server/src/api/controllers/public/mapping/queries.ts index 024623058b..748e0e3370 100644 --- a/packages/server/src/api/controllers/public/mapping/queries.ts +++ b/packages/server/src/api/controllers/public/mapping/queries.ts @@ -26,8 +26,10 @@ function mapQueryExecution(ctx: any): ExecuteQueryOutput { return { data: ctx.body.data, pagination: ctx.body.pagination, - extra: ctx.body.extra, - info: ctx.body.info, + extra: { + raw: ctx.body.raw, + headers: ctx.body.headers, + }, } } diff --git a/packages/server/src/api/controllers/public/types/openapi.ts b/packages/server/src/api/controllers/public/types/openapi.ts index 89537d828e..e3c70f18a2 100644 --- a/packages/server/src/api/controllers/public/types/openapi.ts +++ b/packages/server/src/api/controllers/public/types/openapi.ts @@ -850,8 +850,6 @@ export interface components { /** @description The raw query response, as a string. */ raw?: string } - /** @description Extra info from the query in a key-value map, like response times. */ - info?: { [key: string]: unknown } /** @description If pagination is supported, this will contain the bookmark/anchor information for it. */ pagination?: { [key: string]: unknown } } diff --git a/specs/openapi.json b/specs/openapi.json new file mode 120000 index 0000000000..6e1531e3f4 --- /dev/null +++ b/specs/openapi.json @@ -0,0 +1 @@ +../packages/server/specs/openapi.json \ No newline at end of file diff --git a/specs/openapi.yaml b/specs/openapi.yaml new file mode 120000 index 0000000000..67db6af71f --- /dev/null +++ b/specs/openapi.yaml @@ -0,0 +1 @@ +../packages/server/specs/openapi.yaml \ No newline at end of file