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

Generated OpenAPI for multiple return types is incorrect

    XMLWordPrintable

Details

    • Bug Report
    • Status: Closed
    • L3 - Default
    • Resolution: Fixed
    • 7.14.5, 7.15.0-alpha3
    • 7.15.0-alpha4, 7.14.6, 7.15.0
    • None
    • None

    Description

      Observed Behavior (Required on creation):

      When looking at it in swaggerui and also the openapi.json file itself, the following endpoints only have one response type for the 200 status response. However, there are two response types defined in the corresponding freemarker file. (Additionally, if it is present, the application/xhtml+xml examples are also not rendered correctly):

      • /task/{id}/deployed-form
      • /process-definition/{id}/deployed-start-form
      • /history/process-instance/report

      Expected behavior (Required on creation):

      All response types should be present in the openapi.json

      Root Cause (Required on prioritization):

      The problem is that the second response overwrites the first as it duplicates the "200" key. This part probably requires manual json or an adjustment of the macros.

      Hints (Optional):

      This might also affect other endpoints. So it would make sense to check the macro for response and see if we can at least integrate a warning if a key is overwritten.

      mgm-controller-panel

        This is the controller panel for Smart Panels app

        Attachments

          Activity

            People

              Unassigned Unassigned
              anton.weltzien Anton von Weltzien
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Salesforce