Adding a top level script for generating specs, symlinking the openap…

…i yaml and json to top level as well.
waynelwz · Mar 1, 2022 · d7dbcb2 · d7dbcb2
1 parent d8b5cae
commit d7dbcb2
Show file tree

Hide file tree

Showing 8 changed files with 7 additions and 16 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -0,0 +1 @@
+../packages/server/specs/openapi.json
diff --git a/specs/openapi.yaml b/specs/openapi.yaml
@@ -0,0 +1 @@
+../packages/server/specs/openapi.yaml