add variable component

ctrlplanedev · Nov 14, 2024 · b4f46d1 · b4f46d1
1 parent bcef450
commit b4f46d1
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 124 deletions.
diff --git a/apps/webservice/src/app/api/v1/openapi.ts b/apps/webservice/src/app/api/v1/openapi.ts
@@ -15,5 +15,26 @@ export const openapi: Swagger.SwaggerV3 = {
         name: "x-api-key",
       },
     },
+    schemas: {
+      Variable: {
+        type: "object",
+        required: ["key", "value"],
+        properties: {
+          key: {
+            type: "string",
+          },
+          value: {
+            oneOf: [
+              { type: "string" },
+              { type: "number" },
+              { type: "boolean" },
+            ],
+          },
+          sensitive: {
+            type: "boolean",
+          },
+        },
+      },
+    },
   },
 };
diff --git a/apps/webservice/src/app/api/v1/resources/[targetId]/openapi.ts b/apps/webservice/src/app/api/v1/resources/[targetId]/openapi.ts
@@ -82,24 +82,7 @@ export const openapi: Swagger.SwaggerV3 = {
                     variables: {
                       type: "array",
                       items: {
-                        type: "object",
-                        properties: {
-                          key: {
-                            type: "string",
-                          },
-                          value: {
-                            oneOf: [
-                              { type: "string" },
-                              { type: "number" },
-                              { type: "boolean" },
-                            ],
-                          },
-                          sensitive: {
-                            type: "boolean",
-                            default: false,
-                          },
-                        },
-                        required: ["key", "value"],
+                        $ref: "#/components/schemas/Variable",
                       },
                     },
                   },
@@ -187,24 +170,7 @@ export const openapi: Swagger.SwaggerV3 = {
                   variables: {
                     type: "array",
                     items: {
-                      type: "object",
-                      properties: {
-                        key: {
-                          type: "string",
-                        },
-                        value: {
-                          oneOf: [
-                            { type: "string" },
-                            { type: "number" },
-                            { type: "boolean" },
-                          ],
-                        },
-                        sensitive: {
-                          type: "boolean",
-                          default: false,
-                        },
-                      },
-                      required: ["key", "value"],
+                      $ref: "#/components/schemas/Variable",
                     },
                   },
                 },

diff --git a/apps/webservice/src/app/api/v1/resources/openapi.ts b/apps/webservice/src/app/api/v1/resources/openapi.ts
@@ -59,23 +59,7 @@ export const openapi: Swagger.SwaggerV3 = {
                         variables: {
                           type: "array",
                           items: {
-                            type: "object",
-                            required: ["key", "value"],
-                            properties: {
-                              key: {
-                                type: "string",
-                              },
-                              value: {
-                                oneOf: [
-                                  { type: "string" },
-                                  { type: "number" },
-                                  { type: "boolean" },
-                                ],
-                              },
-                              sensitive: {
-                                type: "boolean",
-                              },
-                            },
+                            $ref: "#/components/schemas/Variable",
                           },
                         },
                       },

diff --git a/openapi.v1.json b/openapi.v1.json
@@ -1020,30 +1020,7 @@
                     "variables": {
                       "type": "array",
                       "items": {
-                        "type": "object",
-                        "properties": {
-                          "key": {
-                            "type": "string"
-                          },
-                          "value": {
-                            "oneOf": [
-                              {
-                                "type": "string"
-                              },
-                              {
-                                "type": "number"
-                              },
-                              {
-                                "type": "boolean"
-                              }
-                            ]
-                          },
-                          "sensitive": {
-                            "type": "boolean",
-                            "default": false
-                          }
-                        },
-                        "required": ["key", "value"]
+                        "$ref": "#/components/schemas/Variable"
                       }
                     }
                   },
@@ -1131,30 +1108,7 @@
                   "variables": {
                     "type": "array",
                     "items": {
-                      "type": "object",
-                      "properties": {
-                        "key": {
-                          "type": "string"
-                        },
-                        "value": {
-                          "oneOf": [
-                            {
-                              "type": "string"
-                            },
-                            {
-                              "type": "number"
-                            },
-                            {
-                              "type": "boolean"
-                            }
-                          ]
-                        },
-                        "sensitive": {
-                          "type": "boolean",
-                          "default": false
-                        }
-                      },
-                      "required": ["key", "value"]
+                      "$ref": "#/components/schemas/Variable"
                     }
                   }
                 }
@@ -1345,29 +1299,7 @@
                         "variables": {
                           "type": "array",
                           "items": {
-                            "type": "object",
-                            "required": ["key", "value"],
-                            "properties": {
-                              "key": {
-                                "type": "string"
-                              },
-                              "value": {
-                                "oneOf": [
-                                  {
-                                    "type": "string"
-                                  },
-                                  {
-                                    "type": "number"
-                                  },
-                                  {
-                                    "type": "boolean"
-                                  }
-                                ]
-                              },
-                              "sensitive": {
-                                "type": "boolean"
-                              }
-                            }
+                            "$ref": "#/components/schemas/Variable"
                           }
                         }
                       }
@@ -1725,6 +1657,33 @@
     }
   },
   "components": {
+    "schemas": {
+      "Variable": {
+        "type": "object",
+        "required": ["key", "value"],
+        "properties": {
+          "key": {
+            "type": "string"
+          },
+          "value": {
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "number"
+              },
+              {
+                "type": "boolean"
+              }
+            ]
+          },
+          "sensitive": {
+            "type": "boolean"
+          }
+        }
+      }
+    },
     "securitySchemes": {
       "apiKey": {
         "type": "apiKey",