Uploaded image for project: 'camunda BPM'
  1. camunda BPM
  2. CAM-13429

OpenAPI: Requests and responses can use multiple schemas

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Won't Fix
    • Icon: L3 - Default L3 - Default
    • None
    • None
    • engine
    • None

      User story:

      The OpenAPI specification provides the oneOf, anyOf, allOf and not keywords, which can be used to combine multiple schemas, or validate a value against multiple criteria.

      Acceptance Criteria (Required on creation):

      • Support for these keywords is added to the camunda-engine-rest-openapi project.
      • Existing endpoints that may return instances of multiple schemas are migrated:
        • oneOf: HistoricDetailDto should be extended by HistoricVariableUpdateDto and HistoricFormFieldDto.
        • oneof: paths/history/task/report/get.ftl should use HistoricTaskInstanceReportResultDto and DurationReportResultDto in the }}{{200 response.

      Hints (Optional):

      The openapi-generator contains a bug (https://github.com/OpenAPITools/openapi-generator/issues/5382) that results in the generated code related to these keywords to fail.

      Support for these keywords can't be implemented until the bug is completely resolved, as we aim to support a wide range of client generation libraries,

        This is the controller panel for Smart Panels app

              Unassigned Unassigned
              nikola.koevski Nikola Koevski
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: