Talend Batch Component needs Vulcan Engine to leverage OpenAPI specification output with meta data on data transfer objects full class names

• Type: Bug
• Status: Closed
• Resolution: Fixed
• Affects Version/s: Master
• Fix Version/s: 7.0.X, 7.1.X, 7.2.10 DXP FP3, 7.2.X, 7.2.1 CE GA2, 7.3.0 CE GA1, Master
• Component/s: Dev Tools, Headless Delivery API
• Labels:
  • CA
  • liferay-fixpack-dxp-3-7210
• Branch Version/s:
  7.2.x, 7.1.x, 7.0.x
• Backported to Branch:
  Committed
• Fix Priority: 3

Batch API needs version and full class name of Data transfer object that will be used for batch data deserialization.

Vulcan Engine is aware of full class name of DTOs that are part of

components/schemas

section of dynamically served rest-openapi.yaml file.

Please update OpenAPI specification schema section with extra metadata on DTO full class name.

Benefits: Integration tools like Talend, Mulesoft and Informatica Components can fully automate data exchange if this information is available to component via OpenAPI spec. Otherwise the process of building integration flows requires user acknowledgment of implementation details specific to Java programming language used by Liferay platforms.

Initial brainstorming proposal. Served OpenApi can use description key to set full class path that is used to deserialize content:

 

components:
  schemas:
    Attachment:
       properties:
         prop1:
           type: string
         prop2:
           type: string
         prop3:
           type: integer
      required:
        - prop2
      type: object
      description:
com.liferay.headless.commerce.admin.catalog.dto.v1_0.Attachment
    Price:
      properties:
      required:
      type: object
      description:
com.liferay.headless.commerce.admin.catalog.dto.v1_0.Price

 

Please note that I haven't go deeply into OpenAPI spec and JSON Schema, so if description key is not good match please propose better design.