vviinn-widgets 2.18.21 → 2.19.1

package/dist/types/interfaces/generated.d.ts

@@ -3,18 +3,6 @@
  * Do not make direct changes to the file.
  */
 export interface paths {
-  "/products": {
-    /** Returns all products which has at least one image */
-    get: operations["GetProducts"];
-  };
-  "/category-tree": {
-    /** Save or publish the categoryTree */
-    put: operations["SaveCategoryTree"];
-  };
-  "/product/{product-id}/annotation": {
-    /** Save or publish the product */
-    put: operations["SaveProduct"];
-  };
   "/product/{product-id}/similar-products": {
     /** Return most similar products to input one */
     get: operations["GetSimilarProductsToInputImage"];
@@ -31,34 +19,17 @@ export interface paths {
     /** Return cross selling products to input one in specific category */
     get: operations["GetCrossSellingProductsToInputImageInSpecificCategory"];
   };
-  "/image/{image-id}": {
-    /** Deletes all images from a site on a given image id */
-    delete: operations["DeleteImageById"];
-  };
-  "/product/{product-id}/full": {
-    /** Deletes product and its images from a site on a given product id */
-    delete: operations["DeleteFullProduct"];
-    parameters: {
-      path: {
-        "product-id": string;
-      };
-    };
-  };
   "/product/{product-id}": {
-    /** Deletes all images from a site on a given product id */
-    delete: operations["DeleteImageByProductId"];
+    /** Creates a new product or updates an existing one */
+    put: operations["SetProduct"];
+    /** Deletes product and its images from a site on a given product id */
+    delete: operations["DeleteProduct"];
     parameters: {
       path: {
         "product-id": string;
       };
     };
   };
-  "/product/{product-id}/image/{image-id}": {
-    /** Upload image directly to catalog and trigger feature extraction */
-    put: operations["AddImage"];
-    /** Deletes all images from a site on given product and image ids */
-    delete: operations["DeleteImageByImageIdAndProductId"];
-  };
   "/search/session": {
     /** Starts a reusable search session for a one image. */
     post: operations["CreateSearchSession"];
@@ -91,8 +62,11 @@ export interface components {
   schemas: {
     "ion-detected-object-rectangle": {
       left?: number;
+      /** @example 0.3641 */
       top?: number;
+      /** @example 0.94 */
       width?: number;
+      /** @example 0.54175 */
       height?: number;
     };
     "ion-detected-object-value": {
@@ -110,142 +84,162 @@ export interface components {
     "ion-detected-objects": {
       value?: components["schemas"]["ion-detected-object"][];
     };
-    "delete-image-by-productId-and-imageId-404-error": {
-      "site-id"?: number;
-      "product-id"?: string;
-      "image-id"?: string;
-    };
-    "delete-image-by-productId-and-imageId-400-error": {
-      siteId?: number;
-      imageCode?: string;
-      productCode?: string;
-    };
     "delete-image-error": {
+      /** @example 25 */
       "site-id"?: number;
+      /** @example 1 */
       "image-id"?: string;
     };
-    "delete-image-by-imageId": {
-      "site-id"?: number;
-      "number-of-products"?: number;
-      "image-id"?: string;
-    };
-    "image-by-productId-and-imageId": {
-      "site-id"?: number;
-      "product-id"?: string;
-      "image-id"?: string;
-      url?: string;
-    };
-    "delete-product-images-by-productId": {
-      "site-id"?: number;
-      "product-id"?: string;
-      "image-ids"?: unknown[];
-    };
     "product-data": {
-      title: string;
-      description?: string;
-      link?: string;
-      availability?: "in_stock" | "out_of_stock" | "preorder" | "backorder";
-      availability_date?: string;
-      cost_of_goods_sold?: string;
-      expiration_date?: string;
-      price?: number;
-      sale_price?: number;
-      sale_price_effective_date?: string;
-      unit_pricing_measure?: string;
-      unit_pricing_base_measure?: string;
-      installment?: string;
-      subscription_cost?: string;
-      loyalty_points?: string;
-      google_product_category?: string;
-      product_type?: string;
-      brand?: string;
-      gtin?: string;
-      mpn?: string;
-      identifier_exists?: boolean;
-      condition?: "new" | "refurbished" | "used";
-      adult?: boolean;
-      multipack?: number;
-      is_bundle?: boolean;
-      energy_efficiency_class?: "A+++" | "A++" | "A+" | "A" | "B" | "C" | "D" | "E" | "F" | "G";
-      min_energy_efficiency_class?: "A+++" | "A++" | "A+" | "A" | "B" | "C" | "D" | "E" | "F" | "G";
-      max_energy_efficiency_class?: "A+++" | "A++" | "A+" | "A" | "B" | "C" | "D" | "E" | "F" | "G";
-      age_group?: "newborn" | "infant" | "toddler" | "kids" | "adult";
-      color?: string;
-      gender?: "male" | "female" | "unisex";
-      material?: string;
-      pattern?: string;
-      size?: string;
-      size_type?: "regular" | "petite" | "tall" | "plus" | "big" | "maternity";
-      size_system?: "AU" | "BR" | "CN" | "DE" | "EU" | "FR" | "IT" | "JP" | "MEX" | "UK" | "US";
-      item_group_id?: string;
-      ads_redirect?: string;
-      custom_label_0?: string;
-      custom_label_1?: string;
-      custom_label_2?: string;
-      custom_label_3?: string;
-      custom_label_4?: string;
-      promotion_id?: string;
-      excluded_destination?: "Shopping_ads" | "Buy_on_Google_listings" | "Display_ads" | "Local_inventory_ads" | "Free_listings" | "Free_local_listings";
-      included_destination?: "Shopping_ads" | "Buy_on_Google_listings" | "Display_ads" | "Local_inventory_ads" | "Free_listings" | "Free_local_listings";
-      shipping?: string;
-      shipping_label?: string;
-      shipping_weight?: string;
-      shipping_length?: string;
-      shipping_width?: string;
-      shipping_height?: string;
-      transit_time_label?: string;
-      max_handling_time?: string;
-      min_handling_time?: string;
-      tax?: string;
-      tax_category?: string;
-      product_detail?: string;
-      shopping_ads_excluded_country?: string;
-      product_highlight?: string;
-      categories?: unknown[];
+      /** @example product title */
+      title?: string | null;
+      /** @example product description */
+      description?: string | null;
+      /** @example https://www.example.com/writing/google-pens */
+      link?: string | null;
+      /** @example https://www.m.example.com/writing/fiji-pens */
+      mobile_link?: string | null;
+      /** @example in_stock */
+      availability?: ("in_stock" | "out_of_stock" | "preorder" | "backorder") | null;
+      /** @example 18.5 */
+      price?: number | null;
+      /** @example 25.5 */
+      sale_price?: number | null;
+      /**
+       * @description Only category paths are supported.
+       * @example Apparel & Accessories > Clothing > Dresses
+       */
+      google_product_category?: string | null;
+      /** @example Home > Women > Dresses > Maxi Dresses, Home > Women > Dresses > Party Dresses */
+      product_type?: string | null;
+      /** @example Google */
+      brand?: string | null;
+      /** @example 3234567890126, 123456788787, 98746543218 */
+      gtin?: string | null;
+      /** @example GO12345OOGLE */
+      mpn?: string | null;
+      /** @example new */
+      condition?: ("new" | "refurbished" | "used") | null;
+      /** @example true */
+      adult?: boolean | null;
+      /** @example 6 */
+      multipack?: number | null;
+      is_bundle?: boolean | null;
+      /** @example A+ */
+      energy_efficiency_class?: ("A+++" | "A++" | "A+" | "A" | "B" | "C" | "D" | "E" | "F" | "G") | null;
+      /** @example C */
+      min_energy_efficiency_class?: ("A+++" | "A++" | "A+" | "A" | "B" | "C" | "D" | "E" | "F" | "G") | null;
+      /** @example A++ */
+      max_energy_efficiency_class?: ("A+++" | "A++" | "A+" | "A" | "B" | "C" | "D" | "E" | "F" | "G") | null;
+      /** @example infant */
+      age_group?: ("newborn" | "infant" | "toddler" | "kids" | "adult") | null;
+      /** @example Orange Mango Explosion */
+      color?: string | null;
+      /** @example female */
+      gender?: ("male" | "female" | "unisex") | null;
+      /** @example Leather */
+      material?: string | null;
+      /** @example Striped */
+      pattern?: string | null;
+      /** @example XL */
+      size?: string | null;
+      /** @example petite */
+      size_type?: ("regular" | "petite" | "tall" | "plus" | "big" | "maternity") | null;
+      /** @example UK */
+      size_system?: ("AU" | "BR" | "CN" | "DE" | "EU" | "FR" | "IT" | "JP" | "MEX" | "UK" | "US") | null;
+      /** @example AB12345 */
+      item_group_id?: string | null;
+      /** @example summer */
+      custom_label_0?: string | null;
+      /** @example summer */
+      custom_label_1?: string | null;
+      /** @example summer */
+      custom_label_2?: string | null;
+      /** @example summer */
+      custom_label_3?: string | null;
+      /** @example summer */
+      custom_label_4?: string | null;
+      /** @example tbby123_us */
+      promotion_id?: string | null;
+      /** @example General:Product Type:Digital player,General:Digital Player Type:Flash based,Display:Resolution:432 x 240,Display:Diagonal Size:"2.5" */
+      product_detail?: string | null;
+      /** @example "Supports thousands of apps, including Netflix, YouTube, HBO Now, Spotify, Showtime, Pandora, Google Play Movies", "1080p maximum display resolution" */
+      product_highlight?: string | null;
+      /** @example 30 cm */
+      product_length?: string | null;
+      /** @example 30 cm */
+      product_width?: string | null;
+      /** @example 30 cm */
+      product_height?: string | null;
+      /** @example 10 kg */
+      product_weight?: string | null;
     };
     product: {
+      /** @example 11 */
       "site-id"?: number;
+      /** @example 100257 */
       "product-id"?: string;
       data?: components["schemas"]["product-data"];
     };
     "product-annotation": {
+      /** @example success */
       message: string;
       data: components["schemas"]["product"];
     }[];
+    /** Product images object */
     "product-annotation-images": {
       url?: string;
     };
     "product-annotation-error": {
+      /** @example Could not save or publish the product */
       message: string;
       data: components["schemas"]["product"];
+      /** @example exception message */
       debug?: string;
     }[];
     "category-tree": {
+      /** @example 100 */
       id: string;
+      /** @example title */
       title: string;
+      /** @example 100 */
       parentId: string;
     }[];
     products: {
+      /** @example 05848170643ab0deb9914566391c0c63,0f4f08358666c54b4fde3d83d2b7ef04 */
       productIds?: unknown[];
     };
     "visual-product-search-object": {
+      /** @example 55fc5f71d6362321cb93b82b387e2f32 */
       groupId?: string | null;
+      /** @example 55fc5f71d6362321cb93b82b387e2f32 */
       productId?: string;
+      /** @example Livingwalls Fototapete Walls by Patel iconic 3 */
       title?: string;
-      /** link to the product detail page */
+      /**
+       * @description link to the product detail page
+       * @example http://mainUrl/site/5/product/55fc5f71d6362321cb93b82b387e2f32/details
+       */
       deeplink?: string | null;
+      /** @example Fender */
       brand?: string | null;
+      /** @example guitar */
       productType?: string | null;
       image?: {
+        /** @example http://mainUrl/image.jpg */
         original?: string;
+        /** @example http://mainUrl/thumbnail-image.jpg */
         thumbnail?: string | null;
       };
       price?: {
+        /** @example 39.95 */
         actual?: number | null;
+        /** @example 24.95 */
         sale?: number | null;
       };
     };
     "category-filter": components["schemas"]["ion-link"] & {
+      /** @example Kinder */
       name: string;
     };
     "name-value-item": {
@@ -253,7 +247,9 @@ export interface components {
       value: string;
     };
     "ion-link": {
+      /** @example POST */
       method: string;
+      /** Format: uri */
       href: string;
     };
     "search-area": components["schemas"]["ion-link"] & {
@@ -267,77 +263,116 @@ export interface components {
     "visual-product-search": components["schemas"]["visual-product-search-object"][];
     "ion-visual-product-search": {
       value?: components["schemas"]["visual-product-search-object"][];
+      /** @example array */
       type?: string;
       searchArea?: components["schemas"]["search-area"];
       uploadHighResolutionImage?: components["schemas"]["upload-high-resolution-image"];
       filters?: {
+        /** @example object */
         type?: string;
         value?: {
           categories?: components["schemas"]["category-filter"][];
         };
       };
+      /** @example [object Object] */
       links?: {
         [key: string]: components["schemas"]["ion-link"];
       };
       detectedObjects?: components["schemas"]["ion-detected-object"][];
     };
     "visual-product-recommendations": {
+      /** @example b56764137ca959da9541bb28c1987d6c,b5685a5230f5050475f214b4bb0e239b,b56c560872da93602ff88c7267eb4774,d861ad687c60820255dbf8f88516f24d */
       bestFits?: string[];
       extended?: components["schemas"]["visual-product-search"][];
     };
     predict_product: {
-      /** the id of the product for which to make a prediction */
+      /**
+       * @description the id of the product for which to make a prediction
+       * @example 0010020000VR
+       */
       id: string;
     };
     predicted_product: {
-      /** the id of the product to which the predictions belong */
+      /**
+       * @description the id of the product to which the predictions belong
+       * @example 0010020000VR
+       */
       id: string;
-      /** each object represents a field of the product with its predicted value */
+      /** @description each object represents a field of the product with its predicted value */
       fields: components["schemas"]["predicted_field"][];
-      /** each object represents an image of the product with its predicted fields */
+      /** @description each object represents an image of the product with its predicted fields */
       images: components["schemas"]["predicted_image"][];
     };
     predicted_image: {
-      /** the url that identifies the image */
+      /**
+       * @description the url that identifies the image
+       * @example https://www.example.org/image.jpg
+       */
       url: string;
-      /** each object represents a field of the image with its predicted value */
+      /** @description each object represents a field of the image with its predicted value */
       fields: components["schemas"]["predicted_field"][];
     };
-    /** this object contains a prediction for a field */
+    /** @description this object contains a prediction for a field */
     predicted_field: {
-      /** the fields's name */
+      /**
+       * @description the fields's name
+       * @example color
+       */
       name: string;
-      /** the fields's known value (according to the product catalog) */
+      /**
+       * @description the fields's known value (according to the product catalog)
+       * @example red
+       */
       value: unknown | null;
-      /** the fields's predicted value */
+      /**
+       * @description the fields's predicted value
+       * @example orange
+       */
       prediction: unknown | null;
     };
-    /** This is top-level object based on Google's JSON style guide (https://google.github.io/styleguide/jsoncstyleguide.xml#Reserved_Property_Names_in_the_error_object). */
+    /**
+     * Error Response
+     * @description This is top-level object based on Google's JSON style guide (https://google.github.io/styleguide/jsoncstyleguide.xml#Reserved_Property_Names_in_the_error_object).
+     */
     error_response: {
-      /** Represents the code for this error. This property value will usually represent the HTTP response code. If there are multiple errors, code will be the error code for the first error. */
+      /**
+       * @description Represents the code for this error. This property value will usually represent the HTTP response code. If there are multiple errors, code will be the error code for the first error.
+       * @example 500
+       */
       code: number;
-      /** A human readable message providing more details about the error. If there are multiple errors, message will be the message for the first error. */
+      /** @description A human readable message providing more details about the error. If there are multiple errors, message will be the message for the first error. */
       message: string;
-      /** Container for any additional information regarding the error. If the service returns multiple errors, each element in the errors array represents a different error. */
+      /** @description Container for any additional information regarding the error. If the service returns multiple errors, each element in the errors array represents a different error. */
       errors?: components["schemas"]["error_object"][];
     };
-    /** This is a distinct error in an error response, also based on Google's JSON style guide (https://google.github.io/styleguide/jsoncstyleguide.xml#Reserved_Property_Names_in_the_error_object). */
+    /**
+     * Error Object
+     * @description This is a distinct error in an error response, also based on Google's JSON style guide (https://google.github.io/styleguide/jsoncstyleguide.xml#Reserved_Property_Names_in_the_error_object).
+     */
     error_object: {
-      /** Unique identifier for the service raising this error. This helps distinguish service-specific errors (i.e. error inserting an event in a calendar) from general protocol errors (i.e. file not found). */
+      /** @description Unique identifier for the service raising this error. This helps distinguish service-specific errors (i.e. error inserting an event in a calendar) from general protocol errors (i.e. file not found). */
       domain?: string;
-      /** Unique identifier for this error. Different from the error.code property in that this is not an http response code. */
+      /** @description Unique identifier for this error. Different from the error.code property in that this is not an http response code. */
       reason?: string;
-      /** A human readable message providing more details about the error. If there is only one error, this field will match error.message. */
+      /** @description A human readable message providing more details about the error. If there is only one error, this field will match error.message. */
       message: string;
-      /** The location of the error (the interpretation of its value depends on location_type). */
+      /** @description The location of the error (the interpretation of its value depends on location_type). */
       location?: string;
-      /** Indicates how the location property should be interpreted. */
+      /** @description Indicates how the location property should be interpreted. */
       location_type?: string;
-      /** A URI for a help text that might shed some more light on the error. */
+      /** @description A URI for a help text that might shed some more light on the error. */
       extended_help?: string;
-      /** A URI for a report form used by the service to collect data about the error condition. This URI should be preloaded with parameters describing the request. */
+      /** @description A URI for a report form used by the service to collect data about the error condition. This URI should be preloaded with parameters describing the request. */
       send_report?: string;
     };
+    "delete-product-images-by-productId": {
+      /** @example 25 */
+      "site-id"?: number;
+      /** @example 100258 */
+      "product-id"?: string;
+      /** @example 1,2 */
+      "image-ids"?: unknown[];
+    };
   };
   responses: {
     /** detected objects response */
@@ -402,81 +437,6 @@ export interface components {
   };
 }
 export interface operations {
-  /** Returns all products which has at least one image */
-  GetProducts: {
-    responses: {
-      /** success */
-      200: {
-        content: {
-          "application/json": components["schemas"]["products"];
-        };
-      };
-      /** An exception occurred on products */
-      400: {
-        content: {
-          "application/json": unknown;
-        };
-      };
-      401: components["responses"]["authentication-error"];
-      403: components["responses"]["authorization-error"];
-    };
-  };
-  /** Save or publish the categoryTree */
-  SaveCategoryTree: {
-    responses: {
-      /** success */
-      200: {
-        content: {
-          "application/json": unknown;
-        };
-      };
-      /** Could not save or publish the category */
-      400: {
-        content: {
-          "application/json": unknown;
-        };
-      };
-      401: components["responses"]["authentication-error"];
-      403: components["responses"]["authorization-error"];
-      /** Invalid structure passed to endpoint */
-      422: {
-        content: {
-          "application/json": unknown;
-        };
-      };
-    };
-    /** List of category objects */
-    requestBody: {
-      content: {
-        "application/json": components["schemas"]["category-tree"];
-      };
-    };
-  };
-  /** Save or publish the product */
-  SaveProduct: {
-    parameters: {
-      path: {
-        "product-id": string;
-      };
-    };
-    responses: {
-      /** success */
-      200: {
-        content: {
-          "application/json": components["schemas"]["product-annotation"];
-        };
-      };
-      /** Could not save or publish the product */
-      400: {
-        content: {
-          "application/json": components["schemas"]["product-annotation-error"];
-        };
-      };
-      401: components["responses"]["authentication-error"];
-      403: components["responses"]["authorization-error"];
-    };
-    requestBody: components["requestBodies"]["product-annotation"];
-  };
   /** Return most similar products to input one */
   GetSimilarProductsToInputImage: {
     parameters: {
@@ -603,48 +563,8 @@ export interface operations {
       };
     };
   };
-  /** Deletes all images from a site on a given image id */
-  DeleteImageById: {
-    parameters: {
-      path: {
-        "image-id": string;
-      };
-    };
-    responses: {
-      /** success */
-      200: {
-        content: {
-          "application/json": {
-            message?: string;
-            data?: components["schemas"]["delete-image-by-imageId"];
-          };
-        };
-      };
-      /** Could not delete the image */
-      400: {
-        content: {
-          "application/json": {
-            message?: string;
-            data?: components["schemas"]["delete-image-error"];
-            debug?: string;
-          };
-        };
-      };
-      401: components["responses"]["authentication-error"];
-      403: components["responses"]["authorization-error"];
-      /** Unable to find any matching image */
-      404: {
-        content: {
-          "application/json": {
-            message?: string;
-            data?: components["schemas"]["delete-image-error"];
-          };
-        };
-      };
-    };
-  };
-  /** Deletes product and its images from a site on a given product id */
-  DeleteFullProduct: {
+  /** Creates a new product or updates an existing one */
+  SetProduct: {
     parameters: {
       path: {
         "product-id": string;
@@ -654,37 +574,22 @@ export interface operations {
       /** success */
       200: {
         content: {
-          "application/json": {
-            message?: string;
-            data?: components["schemas"]["delete-product-images-by-productId"];
-          };
+          "application/json": components["schemas"]["product-annotation"];
         };
       };
-      /** Could not delete the image */
+      /** Could not save or publish the product */
       400: {
         content: {
-          "application/json": {
-            message?: string;
-            data?: components["schemas"]["delete-image-error"];
-            debug?: string;
-          };
+          "application/json": components["schemas"]["product-annotation-error"];
         };
       };
       401: components["responses"]["authentication-error"];
       403: components["responses"]["authorization-error"];
-      /** Unable to find any image of the product */
-      404: {
-        content: {
-          "application/json": {
-            message?: string;
-            data?: components["schemas"]["delete-image-error"];
-          };
-        };
-      };
     };
+    requestBody: components["requestBodies"]["product-annotation"];
   };
-  /** Deletes all images from a site on a given product id */
-  DeleteImageByProductId: {
+  /** Deletes product and its images from a site on a given product id */
+  DeleteProduct: {
     parameters: {
       path: {
         "product-id": string;
@@ -695,6 +600,7 @@ export interface operations {
       200: {
         content: {
           "application/json": {
+            /** @example success */
             message?: string;
             data?: components["schemas"]["delete-product-images-by-productId"];
           };
@@ -704,8 +610,10 @@ export interface operations {
       400: {
         content: {
           "application/json": {
+            /** @example Could not delete the image */
             message?: string;
             data?: components["schemas"]["delete-image-error"];
+            /** @example exception message */
             debug?: string;
           };
         };
@@ -716,6 +624,7 @@ export interface operations {
       404: {
         content: {
           "application/json": {
+            /** @example Unable to find any image of the product. */
             message?: string;
             data?: components["schemas"]["delete-image-error"];
           };
@@ -723,96 +632,6 @@ export interface operations {
       };
     };
   };
-  /** Upload image directly to catalog and trigger feature extraction */
-  AddImage: {
-    parameters: {
-      path: {
-        "product-id": string;
-        "image-id": string;
-      };
-    };
-    responses: {
-      /** success */
-      200: {
-        content: {
-          "application/json": {
-            message?: string;
-            data?: components["schemas"]["image-by-productId-and-imageId"];
-          };
-        };
-      };
-      /** Could not save or publish the image */
-      400: {
-        content: {
-          "application/json": {
-            message?: string;
-            data?: components["schemas"]["image-by-productId-and-imageId"];
-            debug?: string;
-          };
-        };
-      };
-      401: components["responses"]["authentication-error"];
-      403: components["responses"]["authorization-error"];
-      /** Unable to find product to add this image to */
-      404: {
-        content: {
-          "application/json": {
-            message?: string;
-            data?: components["schemas"]["image-by-productId-and-imageId"];
-          };
-        };
-      };
-    };
-    /** Image url */
-    requestBody: {
-      content: {
-        "application/x-www-form-urlencoded": {
-          "image-url": string;
-        };
-      };
-    };
-  };
-  /** Deletes all images from a site on given product and image ids */
-  DeleteImageByImageIdAndProductId: {
-    parameters: {
-      path: {
-        "product-id": string;
-        "image-id": string;
-      };
-    };
-    responses: {
-      /** success */
-      200: {
-        content: {
-          "application/json": {
-            message?: string;
-            data?: components["schemas"]["image-by-productId-and-imageId"];
-          };
-        };
-      };
-      /** Could not delete the image */
-      400: {
-        content: {
-          "application/json": {
-            message?: string;
-            data?: components["schemas"]["delete-image-by-productId-and-imageId-400-error"];
-            debug?: string;
-          };
-        };
-      };
-      401: components["responses"]["authentication-error"];
-      403: components["responses"]["authorization-error"];
-      /** Unable to find image. */
-      404: {
-        content: {
-          "application/json": {
-            message?: string;
-            data?: components["schemas"]["delete-image-by-productId-and-imageId-404-error"];
-          };
-        };
-      };
-    };
-  };
   /** Starts a reusable search session for a one image. */
   CreateSearchSession: {
     parameters: {
@@ -834,6 +653,7 @@ export interface operations {
     requestBody: {
       content: {
         "multipart/form-data": {
+          /** Format: binary */
           image: string;
         };
       };
@@ -921,6 +741,7 @@ export interface operations {
       200: {
         content: {
           "application/json": {
+            /** @example success */
             message?: string;
           };
         };