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

REST API: Wrong query parameter name 'deserializeValue' in ProcessInstance API and Task API

XMLWordPrintable

      The query parameter 'deserializeValue' of the REST URL "/process-instance/{id}/variables" has no effect, the returned process variables are deserialized in any case. Same applies for the REST URL "/task/{id}/variables".

      The cause is a wrong parameter name in the OpenApi specification openapi.json (from archive: camunda-engine-rest-openapi-7.13.0.jar). Line 9793 and line 14841: the variable is exptected to be 'deserializeValues' (not 'deserializeValue'). Therefore the decoding of the query parameters goes wrong.

      Note that the documentation is correct:

      https://docs.camunda.org/manual/7.13/reference/rest/process-instance/variables/get-variables/

      https://docs.camunda.org/manual/7.13/reference/rest/task/variables/get-task-variables/

        This is the controller panel for Smart Panels app

          1. CAM-12391_Wrong_parameter_name_'deserializeValue'.patch
            2 kB

            [CAM-12391] REST API: Wrong query parameter name 'deserializeValue' in ProcessInstance API and Task API

            Tobias Metzke-Bernstein added a comment -

            Hi phlox,

            thanks for opening that bug report and for digging into it already.
            I looked into the OpenAPI description and I think that you're right about your findings.

            We will move this into decision making and notify you once there is progress.
            If you're up to it, you can also open a PR in the repository and fix it. This will of course speed up the inclusion of the fix in the next version.
            If you'd like any pointers for that, let us know!

            Thanks again and best regards,
            Tobias

            Tobias Metzke-Bernstein added a comment - Hi phlox , thanks for opening that bug report and for digging into it already. I looked into the OpenAPI description and I think that you're right about your findings. We will move this into decision making and notify you once there is progress. If you're up to it, you can also open a PR in the repository and fix it. This will of course speed up the inclusion of the fix in the next version. If you'd like any pointers for that, let us know! Thanks again and best regards, Tobias

            Daniel Brugger added a comment -

            Hi @Tobias Metzke-Bernstein,

            thanks for your response. We fixed the OpenApi specification in our project environment already and that (temporarily) fixes the issue for us. However, looking forward for the integrated fix in the official product.

            I'm still a beginner with Camunda and therefore I hesitate to open a PR with my fix since I feel that I have not enough knowledge about other dependencies I should also consider (test cases, code generators, documentation, examples...). I hope you can understand.

            Thank you and best regards
            Daniel

            Daniel Brugger added a comment - Hi @Tobias Metzke-Bernstein, thanks for your response. We fixed the OpenApi specification in our project environment already and that (temporarily) fixes the issue for us. However, looking forward for the integrated fix in the official product. I'm still a beginner with Camunda and therefore I hesitate to open a PR with my fix since I feel that I have not enough knowledge about other dependencies I should also consider (test cases, code generators, documentation, examples...). I hope you can understand. Thank you and best regards Daniel

            Thorben Lindhauer added a comment -

            Hi Daniel,

            Thanks for reporting this. We will probably look into this during the development of 7.15, but cannot guarantee it at this point.

            Cheers,
            Thorben

            Thorben Lindhauer added a comment - Hi Daniel, Thanks for reporting this. We will probably look into this during the development of 7.15, but cannot guarantee it at this point. Cheers, Thorben

              Unassigned Unassigned
              phlox Daniel Brugger
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: