From 2002728740f5ab4a49bbeb8517770b8e99b38492 Mon Sep 17 00:00:00 2001 From: mike12345567 Date: Mon, 7 Mar 2022 13:21:30 +0000 Subject: [PATCH] Adding the tenant ID to the Budibase Cloud URL, as well as setting up variables for them all as part of the server URL. --- packages/server/specs/generate.js | 21 +++++++++++++++++++-- packages/server/specs/openapi.json | 24 ++++++++++++++++++++---- packages/server/specs/openapi.yaml | 16 ++++++++++++++-- 3 files changed, 53 insertions(+), 8 deletions(-) diff --git a/packages/server/specs/generate.js b/packages/server/specs/generate.js index d037eb8e59..97a2abb71c 100644 --- a/packages/server/specs/generate.js +++ b/packages/server/specs/generate.js @@ -17,12 +17,29 @@ const options = { }, servers: [ { - url: "http://budibase.app/api/public/v1", + url: "https://{organisationId}.budibase.app/api/public/v1", description: "Budibase Cloud API", + variables: { + organisationId: { + default: "organisation", + description: "The organisation you are attempting to access.", + }, + }, }, { - url: "{protocol}://{hostname}:10000/api/public/v1", + url: "{protocol}://{hostname}/api/public/v1", description: "Budibase self hosted API", + variables: { + protocol: { + default: "http", + description: + "Whether HTTP or HTTPS should be used to communicate with your Budibase instance.", + }, + hostname: { + default: "localhost:10000", + description: "The URL of your Budibase instance.", + }, + }, }, ], components: { diff --git a/packages/server/specs/openapi.json b/packages/server/specs/openapi.json index 3e68d3edca..00f69f2815 100644 --- a/packages/server/specs/openapi.json +++ b/packages/server/specs/openapi.json @@ -7,12 +7,28 @@ }, "servers": [ { - "url": "http://budibase.app/api/public/v1", - "description": "Budibase Cloud API" + "url": "https://{organisationId}.budibase.app/api/public/v1", + "description": "Budibase Cloud API", + "variables": { + "organisationId": { + "default": "organisation", + "description": "The organisation you are attempting to access." + } + } }, { - "url": "{protocol}://{hostname}:10000/api/public/v1", - "description": "Budibase self hosted API" + "url": "{protocol}://{hostname}/api/public/v1", + "description": "Budibase self hosted API", + "variables": { + "protocol": { + "default": "http", + "description": "Whether HTTP or HTTPS should be used to communicate with your Budibase instance." + }, + "hostname": { + "default": "localhost:10000", + "description": "The URL of your Budibase instance." + } + } } ], "components": { diff --git a/packages/server/specs/openapi.yaml b/packages/server/specs/openapi.yaml index 298eb73636..5decd65f6d 100644 --- a/packages/server/specs/openapi.yaml +++ b/packages/server/specs/openapi.yaml @@ -4,10 +4,22 @@ info: description: The public API for Budibase apps and its services. version: 1.0.0 servers: - - url: http://budibase.app/api/public/v1 + - url: https://{organisationId}.budibase.app/api/public/v1 description: Budibase Cloud API - - url: "{protocol}://{hostname}:10000/api/public/v1" + variables: + organisationId: + default: organisation + description: The organisation you are attempting to access. + - url: "{protocol}://{hostname}/api/public/v1" description: Budibase self hosted API + variables: + protocol: + default: http + description: Whether HTTP or HTTPS should be used to communicate with your + Budibase instance. + hostname: + default: localhost:10000 + description: The URL of your Budibase instance. components: parameters: tableId: