docs: add server variables to demo

ref #543
oazapfts · Feb 23, 2024 · 48bc5d0 · 48bc5d0
1 parent d73768f
commit 48bc5d0
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 6 deletions.
diff --git a/demo/api.ts b/demo/api.ts
@@ -13,7 +13,15 @@ export const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders> = {
 const oazapfts = Oazapfts.runtime(defaults);
 export const servers = {
   server1: "https://petstore.swagger.io/v2",
-  server2: "http://petstore.swagger.io/v2",
+  server2: ({
+    protocol = "https",
+    stage = "staging",
+    version = "v1",
+  }: {
+    protocol: "http" | "https";
+    stage: "test" | "staging" | "production";
+    version: "v1" | "v2";
+  }) => `${protocol}://${stage}.petstore.example.org/${version}`,
 };
 export type Category = {
   id?: number;

diff --git a/demo/enumApi.ts b/demo/enumApi.ts
@@ -13,7 +13,15 @@ export const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders> = {
 const oazapfts = Oazapfts.runtime(defaults);
 export const servers = {
   server1: "https://petstore.swagger.io/v2",
-  server2: "http://petstore.swagger.io/v2",
+  server2: ({
+    protocol = "https",
+    stage = "staging",
+    version = "v1",
+  }: {
+    protocol: "http" | "https";
+    stage: "test" | "staging" | "production";
+    version: "v1" | "v2";
+  }) => `${protocol}://${stage}.petstore.example.org/${version}`,
 };
 export type Category = {
   id?: number;

diff --git a/demo/mergedReadWriteApi.ts b/demo/mergedReadWriteApi.ts
@@ -13,7 +13,15 @@ export const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders> = {
 const oazapfts = Oazapfts.runtime(defaults);
 export const servers = {
   server1: "https://petstore.swagger.io/v2",
-  server2: "http://petstore.swagger.io/v2",
+  server2: ({
+    protocol = "https",
+    stage = "staging",
+    version = "v1",
+  }: {
+    protocol: "http" | "https";
+    stage: "test" | "staging" | "production";
+    version: "v1" | "v2";
+  }) => `${protocol}://${stage}.petstore.example.org/${version}`,
 };
 export type Category = {
   id?: number;

diff --git a/demo/objectStyleArgument.ts b/demo/objectStyleArgument.ts
@@ -13,7 +13,15 @@ export const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders> = {
 const oazapfts = Oazapfts.runtime(defaults);
 export const servers = {
   server1: "https://petstore.swagger.io/v2",
-  server2: "http://petstore.swagger.io/v2",
+  server2: ({
+    protocol = "https",
+    stage = "staging",
+    version = "v1",
+  }: {
+    protocol: "http" | "https";
+    stage: "test" | "staging" | "production";
+    version: "v1" | "v2";
+  }) => `${protocol}://${stage}.petstore.example.org/${version}`,
 };
 export type Category = {
   id?: number;

diff --git a/demo/optimisticApi.ts b/demo/optimisticApi.ts
@@ -13,7 +13,15 @@ export const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders> = {
 const oazapfts = Oazapfts.runtime(defaults);
 export const servers = {
   server1: "https://petstore.swagger.io/v2",
-  server2: "http://petstore.swagger.io/v2",
+  server2: ({
+    protocol = "https",
+    stage = "staging",
+    version = "v1",
+  }: {
+    protocol: "http" | "https";
+    stage: "test" | "staging" | "production";
+    version: "v1" | "v2";
+  }) => `${protocol}://${stage}.petstore.example.org/${version}`,
 };
 export type Category = {
   id?: number;

diff --git a/demo/petstore.json b/demo/petstore.json
@@ -22,7 +22,21 @@
       "url": "https://petstore.swagger.io/v2"
     },
     {
-      "url": "http://petstore.swagger.io/v2"
+      "url": "{protocol}://{stage}.petstore.example.org/{version}",
+      "variables": {
+        "protocol": {
+          "enum": ["http", "https"],
+          "default": "https"
+        },
+        "stage": {
+          "enum": ["test", "staging", "production"],
+          "default": "staging"
+        },
+        "version": {
+          "enum": ["v1", "v2"],
+          "default": "v1"
+        }
+      }
     }
   ],
   "tags": [