fix: release metadata in the v1/openapi.ts (#271)

ctrlplanedev · Dec 29, 2024 · 141f048 · 141f048
1 parent fdc4c53
commit 141f048
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 20 deletions.
diff --git a/apps/webservice/src/app/api/v1/openapi.ts b/apps/webservice/src/app/api/v1/openapi.ts
@@ -45,6 +45,7 @@ export const openapi: Swagger.SwaggerV3 = {
           config: { type: "object", additionalProperties: true },
           deploymentId: { type: "string", format: "uuid" },
           createdAt: { type: "string", format: "date-time" },
+          metadata: { type: "object", additionalProperties: true },
         },
         required: [
           "id",

diff --git a/apps/webservice/src/app/api/v1/releases/openapi.ts b/apps/webservice/src/app/api/v1/releases/openapi.ts
@@ -24,8 +24,7 @@ export const openapi: Swagger.SwaggerV3 = {
                   name: { type: "string" },
                   config: { type: "object", additionalProperties: true },
                   metadata: {
-                    type: "object",
-                    additionalProperties: { type: "string" },
+                    $ref: "#/components/schemas/Release/properties/metadata",
                   },
                 },
                 required: ["version", "deploymentId"],
@@ -44,10 +43,7 @@ export const openapi: Swagger.SwaggerV3 = {
                     id: { type: "string" },
                     version: { type: "string" },
                     metadata: {
-                      type: "object",
-                      additionalProperties: {
-                        type: "string",
-                      },
+                      $ref: "#/components/schemas/Release/properties/metadata",
                     },
                   },
                 },

diff --git a/integrations/github-get-job-inputs/src/index.ts b/integrations/github-get-job-inputs/src/index.ts
@@ -78,6 +78,7 @@ async function run() {
       setOutputAndLog("release_id", release?.id);
       setOutputAndLog("release_version", release?.version);
       setOutputsRecursively("release_config", release?.config);
+      setOutputsRecursively("release_metadata", release?.metadata);
 
       if (approval?.approver != null) {
         setOutputAndLog("approval_approver_id", approval.approver.id);

diff --git a/openapi.v1.json b/openapi.v1.json
@@ -1341,10 +1341,7 @@
                     "additionalProperties": true
                   },
                   "metadata": {
-                    "type": "object",
-                    "additionalProperties": {
-                      "type": "string"
-                    }
+                    "$ref": "#/components/schemas/Release/properties/metadata"
                   }
                 },
                 "required": [
@@ -1370,10 +1367,7 @@
                       "type": "string"
                     },
                     "metadata": {
-                      "type": "object",
-                      "additionalProperties": {
-                        "type": "string"
-                      }
+                      "$ref": "#/components/schemas/Release/properties/metadata"
                     }
                   }
                 }
@@ -2356,6 +2350,10 @@
           "createdAt": {
             "type": "string",
             "format": "date-time"
+          },
+          "metadata": {
+            "type": "object",
+            "additionalProperties": true
           }
         },
         "required": [

diff --git a/packages/node-sdk/src/schema.ts b/packages/node-sdk/src/schema.ts
@@ -382,6 +382,9 @@ export interface components {
       deploymentId: string;
       /** Format: date-time */
       createdAt: string;
+      metadata?: {
+        [key: string]: unknown;
+      };
     };
     Environment: {
       /** Format: uuid */
@@ -1249,9 +1252,7 @@ export interface operations {
           config?: {
             [key: string]: unknown;
           };
-          metadata?: {
-            [key: string]: string;
-          };
+          metadata?: components["schemas"]["Release"]["metadata"];
         };
       };
     };
@@ -1265,9 +1266,7 @@ export interface operations {
           "application/json": {
             id?: string;
             version?: string;
-            metadata?: {
-              [key: string]: string;
-            };
+            metadata?: components["schemas"]["Release"]["metadata"];
           };
         };
       };