Merge pull request #4826 from Budibase/fix/openapi-server-urls

Minor OpenAPI spec change

packages/server/specs/generate.js

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

packages/server/specs/openapi.json

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

packages/server/specs/openapi.yaml

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