Browse Source

Adding the tenant ID to the Budibase Cloud URL, as well as setting up variables for them all as part of the server URL.

master
mike12345567 5 years ago
parent
commit
2002728740
  1. 21
      packages/server/specs/generate.js
  2. 24
      packages/server/specs/openapi.json
  3. 16
      packages/server/specs/openapi.yaml

21
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: {

24
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": {

16
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:

Loading…
Cancel
Save