Browse Source
Merge pull request #4826 from Budibase/fix/openapi-server-urls
Minor OpenAPI spec change
master
Michael Drury
5 years ago
committed by
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with
36 additions and
7 deletions
-
packages/server/specs/generate.js
-
packages/server/specs/openapi.json
-
packages/server/specs/openapi.yaml
|
|
|
@ -17,12 +17,23 @@ const options = { |
|
|
|
}, |
|
|
|
servers: [ |
|
|
|
{ |
|
|
|
url: "http://budibase.app/api/public/v1", |
|
|
|
url: "https://budibase.app/api/public/v1", |
|
|
|
description: "Budibase Cloud API", |
|
|
|
}, |
|
|
|
{ |
|
|
|
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: { |
|
|
|
|
|
|
|
@ -7,12 +7,22 @@ |
|
|
|
}, |
|
|
|
"servers": [ |
|
|
|
{ |
|
|
|
"url": "http://budibase.app/api/public/v1", |
|
|
|
"url": "https://budibase.app/api/public/v1", |
|
|
|
"description": "Budibase Cloud API" |
|
|
|
}, |
|
|
|
{ |
|
|
|
"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": { |
|
|
|
|
|
|
|
@ -4,10 +4,18 @@ 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://budibase.app/api/public/v1 |
|
|
|
description: Budibase Cloud API |
|
|
|
- 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: |
|
|
|
parameters: |
|
|
|
tableId: |
|
|
|
|
