updating API Documentation release (version 95_CF219)

image-processor-api/openapi.json

@@ -1 +1 @@
-{"openapi":"3.0.3","info":{"version":"1.31.0","title":"image-processor API","x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description":"Presents developer entry points to the Digital Asset Management Image Processor functions of HCL DX"},"paths":{"/dx/api/image-processor/v1/images/resize":{"post":{"operationId":"imagesControllerResize","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"height":{"type":"number"},"width":{"type":"number"},"scale":{"type":"number"},"keepaspectratio":{"type":"string"},"scaleup":{"type":"string"}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/crop":{"post":{"operationId":"imagesControllerCrop","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"description":"This endpoint returns cropped image based on the top left x,y and bottom right x,y coordinates or the specific region","parameters":[],"requestBody":{"required":true,"description":"The actual image to be cropped","content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"topLeftX":{"type":"number"},"topLeftY":{"type":"number"},"bottomRightX":{"type":"number"},"bottomRightY":{"type":"number"},"region":{"type":"string"}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/rotate":{"post":{"operationId":"imagesControllerRotate","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"rotation":{"type":"number"},"background":{"type":"object"}},"type":"object","required":["file","rotation"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/transparency":{"post":{"operationId":"imagesControllerTransparency","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"opacity":{"type":"number"}},"type":"object","required":["file","opacity"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/convert":{"post":{"operationId":"imagesControllerConvert","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"fileType":{"type":"string","minLength":1}},"type":"object","required":["file","fileType"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/flip":{"post":{"operationId":"imagesControllerFlip","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"vertical":{"type":"boolean"},"horizontal":{"type":"boolean"}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/getMetaData":{"post":{"operationId":"imagesControllerGetMetaData","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/config":{"get":{"operationId":"mimeTypeControllerGetMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/config/images":{"get":{"operationId":"mimeTypeControllerGetImagesMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/config/videos":{"get":{"operationId":"mimeTypeControllerGetVideosMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/config/documents":{"get":{"operationId":"mimeTypeControllerGetDocumentsMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/plugin/{action}":{"post":{"operationId":"pluginControllerPerformAction","responses":{"202":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"parameters":[{"in":"path","name":"action","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"callBackURL":{"type":"string","minLength":1},"actionParams":{"type":"object"}},"type":"object","required":["file","callBackURL"]}}}},"tags":["PluginController"]}}},"tags":[{"name":"ImagesController"},{"name":"MimeTypeController"},{"name":"PluginController"}],"components":{"schemas":{"BadRequest":{"type":"object","properties":{"name":{"type":"string","description":"The error name","minLength":1,"example":"BAD_REQUEST","default":"BAD_REQUEST"},"message":{"type":"string","description":"An error message","minLength":1},"status":{"type":"number","description":"The status code of the exception","example":400,"default":400},"errors":{"type":"array","items":{"$ref":"#/components/schemas/GenericError"},"description":"A list of related errors"},"stack":{"type":"string","description":"The stack trace (only in development mode)"}},"required":["name","message","status"]},"GenericError":{"type":"object","properties":{"name":{"type":"string","description":"The error name","minLength":1},"message":{"type":"string","description":"An error message","minLength":1}},"additionalProperties":true,"required":["name","message"]}}}}
+{"openapi":"3.0.3","info":{"version":"1.32.0","title":"image-processor API","x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description":"Presents developer entry points to the Digital Asset Management Image Processor functions of HCL DX"},"paths":{"/dx/api/image-processor/v1/images/resize":{"post":{"operationId":"imagesControllerResize","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"height":{"type":"number"},"width":{"type":"number"},"scale":{"type":"number"},"keepaspectratio":{"type":"string"},"scaleup":{"type":"string"}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/crop":{"post":{"operationId":"imagesControllerCrop","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"description":"This endpoint returns cropped image based on the top left x,y and bottom right x,y coordinates or the specific region","parameters":[],"requestBody":{"required":true,"description":"The actual image to be cropped","content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"topLeftX":{"type":"number"},"topLeftY":{"type":"number"},"bottomRightX":{"type":"number"},"bottomRightY":{"type":"number"},"region":{"type":"string"}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/rotate":{"post":{"operationId":"imagesControllerRotate","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"rotation":{"type":"number"},"background":{"type":"object"}},"type":"object","required":["file","rotation"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/transparency":{"post":{"operationId":"imagesControllerTransparency","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"opacity":{"type":"number"}},"type":"object","required":["file","opacity"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/convert":{"post":{"operationId":"imagesControllerConvert","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"fileType":{"type":"string","minLength":1}},"type":"object","required":["file","fileType"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/flip":{"post":{"operationId":"imagesControllerFlip","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"vertical":{"type":"boolean"},"horizontal":{"type":"boolean"}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/images/getMetaData":{"post":{"operationId":"imagesControllerGetMetaData","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1}},"type":"object","required":["file"]}}}},"tags":["ImagesController"]}},"/dx/api/image-processor/v1/config":{"get":{"operationId":"mimeTypeControllerGetMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/config/images":{"get":{"operationId":"mimeTypeControllerGetImagesMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/config/videos":{"get":{"operationId":"mimeTypeControllerGetVideosMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/config/documents":{"get":{"operationId":"mimeTypeControllerGetDocumentsMimeType","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Success"}},"parameters":[],"tags":["MimeTypeController"]}},"/dx/api/image-processor/v1/plugin/{action}":{"post":{"operationId":"pluginControllerPerformAction","responses":{"202":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"}},"parameters":[{"in":"path","name":"action","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","minLength":1},"callBackURL":{"type":"string","minLength":1},"actionParams":{"type":"object"}},"type":"object","required":["file","callBackURL"]}}}},"tags":["PluginController"]}}},"tags":[{"name":"ImagesController"},{"name":"MimeTypeController"},{"name":"PluginController"}],"components":{"schemas":{"BadRequest":{"type":"object","properties":{"name":{"type":"string","description":"The error name","minLength":1,"example":"BAD_REQUEST","default":"BAD_REQUEST"},"message":{"type":"string","description":"An error message","minLength":1},"status":{"type":"number","description":"The status code of the exception","example":400,"default":400},"errors":{"type":"array","items":{"$ref":"#/components/schemas/GenericError"},"description":"A list of related errors"},"stack":{"type":"string","description":"The stack trace (only in development mode)"}},"required":["name","message","status"]},"GenericError":{"type":"object","properties":{"name":{"type":"string","description":"The error name","minLength":1},"message":{"type":"string","description":"An error message","minLength":1}},"additionalProperties":true,"required":["name","message"]}}}}