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

Camunda Open API TaskQueryDto misses taskId

XMLWordPrintable

    • Icon: Bug Report Bug Report
    • Resolution: Fixed
    • Icon: L3 - Default L3 - Default
    • 7.18.0, 7.18.0-alpha1
    • 7.17.0, 7.15.13, 7.16.7
    • None
    • None

      Environment

      Camunda 7.15+

      Description

      The REST API for task querying via POST request allows to add the parameters "taskId" and "taskIdIn" in the query. The corresponding method in the Open API Spec defines the TaskQueryDTO data structure which misses both parameters. As a result, the query for tasks by specifying ids is not possible if the REST client is generated based on the Open API specification.  

      Steps to reproduce (Required on creation)

      Create a REST client from the OpenAPI specification.

      Observed Behavior (Required on creation):

      TaskQueryDto misses fields "taskId" and "taskIdIn"

      Expected behavior (Required on creation):

      TaskQueryDto contains all fields including "taskId" and "taskIdIn"

      Solution Ideas (Optional):

      Add missing fields to the OpenAPI specification of TaskQueryDto.

      Hints (optional):

        This is the controller panel for Smart Panels app

            [CAM-14522] Camunda Open API TaskQueryDto misses taskId

            Simon Zambrovski added a comment -

            See https://github.com/camunda-community-hub/camunda-rest-client-spring-boot/issues/177 as result

            Simon Zambrovski added a comment - See https://github.com/camunda-community-hub/camunda-rest-client-spring-boot/issues/177 as result

            Tobias Metzke-Bernstein added a comment -

            Hi Simon.Zambrovski@holisticon.de,

            thanks for bringing this up. I can confirm this is missing from the OpenAPI spec of the Task Query DTO.

            We will tackle this as soon as possible.
            If you want to speed up the process, feel free to create a PR that adds the two parameters in the linked DTO specification at
            https://github.com/camunda/camunda-bpm-platform/blob/master/engine-rest/engine-rest-openapi/src/main/templates/models/org/camunda/bpm/engine/rest/dto/runtime/task/TaskQueryDto.ftl.

            Best,
            Tobias

            Tobias Metzke-Bernstein added a comment - Hi Simon.Zambrovski@holisticon.de , thanks for bringing this up. I can confirm this is missing from the OpenAPI spec of the Task Query DTO. We will tackle this as soon as possible. If you want to speed up the process, feel free to create a PR that adds the two parameters in the linked DTO specification at https://github.com/camunda/camunda-bpm-platform/blob/master/engine-rest/engine-rest-openapi/src/main/templates/models/org/camunda/bpm/engine/rest/dto/runtime/task/TaskQueryDto.ftl . Best, Tobias

            Simon Zambrovski added a comment -

            Hi Tobias,

            I just created the PR for this: https://github.com/camunda/camunda-bpm-platform/pull/1862

             

            Best regards,

             

            Simon

            Simon Zambrovski added a comment - Hi Tobias, I just created the PR for this: https://github.com/camunda/camunda-bpm-platform/pull/1862   Best regards,   Simon

            Tobias Metzke-Bernstein added a comment -

            Thanks Simon.Zambrovski@holisticon.de,

            I just approved the PR, it looks good from my side.

            Timing-wise, we are currently preparing the 7.17.0 release.
            Therefore, we will merge it after the technical release is done.
            You can expect to officially see this with the first alpha of 7.18 in May.
            I will keep this here as "RESOLVED" until we can merge it.

            Thanks again and best,
            Tobias

            Tobias Metzke-Bernstein added a comment - Thanks Simon.Zambrovski@holisticon.de , I just approved the PR, it looks good from my side. Timing-wise, we are currently preparing the 7.17.0 release. Therefore, we will merge it after the technical release is done. You can expect to officially see this with the first alpha of 7.18 in May. I will keep this here as "RESOLVED" until we can merge it. Thanks again and best, Tobias

              Unassigned Unassigned
              Simon.Zambrovski@holisticon.de Simon Zambrovski
              Tobias Metzke-Bernstein Tobias Metzke-Bernstein
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: