@quantcdn/quant-client 3.0.2 → 3.0.3

package/dist/api/composeApi.d.ts

@@ -50,12 +50,13 @@ export declare class ComposeApi {
         body: Compose;
     }>;
     /**
-     *
-     * @summary Validate a compose file
+     * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
+     * @summary Validate Docker Compose File
      * @param organisation The organisation ID
-     * @param validateComposeRequest
+     * @param validateComposeRequest The docker-compose.yml file content. Can be sent as raw YAML string or as a JSON wrapper containing both yamlContent (string) and imageSuffix (string) fields. Query parameter imageSuffix takes precedence if both are provided.
+     * @param imageSuffix Optional. Image tag suffix to apply during translation. Transforms internal image tags to consistent \'{containerName}-{suffix}\' format (e.g., \'nginx-pr-456\'). External images are left unchanged. Useful for feature branch deployments.
      */
-    validateCompose(organisation: string, validateComposeRequest: ValidateComposeRequest, options?: {
+    validateCompose(organisation: string, validateComposeRequest: ValidateComposeRequest, imageSuffix?: string, options?: {
         headers: {
             [name: string]: string;
         };

package/dist/api/composeApi.js

@@ -159,12 +159,13 @@ class ComposeApi {
         });
     }
     /**
-     *
-     * @summary Validate a compose file
+     * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
+     * @summary Validate Docker Compose File
      * @param organisation The organisation ID
-     * @param validateComposeRequest
+     * @param validateComposeRequest The docker-compose.yml file content. Can be sent as raw YAML string or as a JSON wrapper containing both yamlContent (string) and imageSuffix (string) fields. Query parameter imageSuffix takes precedence if both are provided.
+     * @param imageSuffix Optional. Image tag suffix to apply during translation. Transforms internal image tags to consistent \'{containerName}-{suffix}\' format (e.g., \'nginx-pr-456\'). External images are left unchanged. Useful for feature branch deployments.
      */
-    validateCompose(organisation, validateComposeRequest, options = { headers: {} }) {
+    validateCompose(organisation, validateComposeRequest, imageSuffix, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/organisations/{organisation}/compose/validate'
                 .replace('{' + 'organisation' + '}', encodeURIComponent(String(organisation)));
@@ -187,6 +188,9 @@ class ComposeApi {
             if (validateComposeRequest === null || validateComposeRequest === undefined) {
                 throw new Error('Required parameter validateComposeRequest was null or undefined when calling validateCompose.');
             }
+            if (imageSuffix !== undefined) {
+                localVarQueryParameters['imageSuffix'] = models_1.ObjectSerializer.serialize(imageSuffix, "string");
+            }
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {

package/dist/model/models.d.ts

@@ -33,6 +33,7 @@ export * from './updateEnvironmentRequest';
 export * from './updateEnvironmentStateRequest';
 export * from './updateEnvironmentVariableRequest';
 export * from './validateCompose200Response';
+export * from './validateCompose422Response';
 export * from './validateComposeRequest';
 export * from './variable';
 export * from './volume';

package/dist/model/models.js

@@ -46,6 +46,7 @@ __exportStar(require("./updateEnvironmentRequest"), exports);
 __exportStar(require("./updateEnvironmentStateRequest"), exports);
 __exportStar(require("./updateEnvironmentVariableRequest"), exports);
 __exportStar(require("./validateCompose200Response"), exports);
+__exportStar(require("./validateCompose422Response"), exports);
 __exportStar(require("./validateComposeRequest"), exports);
 __exportStar(require("./variable"), exports);
 __exportStar(require("./volume"), exports);
@@ -80,6 +81,7 @@ const updateEnvironmentRequest_1 = require("./updateEnvironmentRequest");
 const updateEnvironmentStateRequest_1 = require("./updateEnvironmentStateRequest");
 const updateEnvironmentVariableRequest_1 = require("./updateEnvironmentVariableRequest");
 const validateCompose200Response_1 = require("./validateCompose200Response");
+const validateCompose422Response_1 = require("./validateCompose422Response");
 const validateComposeRequest_1 = require("./validateComposeRequest");
 const variable_1 = require("./variable");
 const volume_1 = require("./volume");
@@ -131,6 +133,7 @@ let typeMap = {
     "UpdateEnvironmentStateRequest": updateEnvironmentStateRequest_1.UpdateEnvironmentStateRequest,
     "UpdateEnvironmentVariableRequest": updateEnvironmentVariableRequest_1.UpdateEnvironmentVariableRequest,
     "ValidateCompose200Response": validateCompose200Response_1.ValidateCompose200Response,
+    "ValidateCompose422Response": validateCompose422Response_1.ValidateCompose422Response,
     "ValidateComposeRequest": validateComposeRequest_1.ValidateComposeRequest,
     "Variable": variable_1.Variable,
     "Volume": volume_1.Volume,

package/dist/model/validateCompose200Response.d.ts

@@ -10,9 +10,15 @@
  * Do not edit the class manually.
  */
 export declare class ValidateCompose200Response {
-    'message'?: string;
-    'translatedComposeDefinition'?: object;
-    'translationWarnings'?: Array<string>;
+    'message': string;
+    /**
+    * The translated internal compose definition format
+    */
+    'translatedComposeDefinition': object;
+    /**
+    * Optional warnings encountered during translation
+    */
+    'translationWarnings'?: Array<string> | null;
     static discriminator: string | undefined;
     static attributeTypeMap: Array<{
         name: string;

package/dist/model/validateCompose422Response.d.ts

@@ -0,0 +1,25 @@
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare class ValidateCompose422Response {
+    'error'?: string;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/dist/model/validateCompose422Response.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidateCompose422Response = void 0;
+class ValidateCompose422Response {
+    static getAttributeTypeMap() {
+        return ValidateCompose422Response.attributeTypeMap;
+    }
+}
+exports.ValidateCompose422Response = ValidateCompose422Response;
+ValidateCompose422Response.discriminator = undefined;
+ValidateCompose422Response.attributeTypeMap = [
+    {
+        "name": "error",
+        "baseName": "error",
+        "type": "string"
+    }
+];

package/dist/model/validateComposeRequest.d.ts

@@ -10,7 +10,18 @@
  * Do not edit the class manually.
  */
 export declare class ValidateComposeRequest {
-    'compose'?: string;
+    /**
+    * The docker-compose.yml file content as a string
+    */
+    'compose': string;
+    /**
+    * Optional image tag suffix (query parameter takes precedence)
+    */
+    'imageSuffix'?: string;
+    /**
+    * Optional application name for context
+    */
+    'application'?: string;
     static discriminator: string | undefined;
     static attributeTypeMap: Array<{
         name: string;

package/dist/model/validateComposeRequest.js

@@ -24,5 +24,15 @@ ValidateComposeRequest.attributeTypeMap = [
         "name": "compose",
         "baseName": "compose",
         "type": "string"
+    },
+    {
+        "name": "imageSuffix",
+        "baseName": "imageSuffix",
+        "type": "string"
+    },
+    {
+        "name": "application",
+        "baseName": "application",
+        "type": "string"
     }
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quantcdn/quant-client",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "TypeScript client for Quant Cloud API",
   "main": "dist/api.js",
   "types": "dist/api.d.ts",