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

In OpenAPI doc, remove default values for boolean parameters

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: L3 - Default L3 - Default
    • None
    • None
    • None

      Scenario:

      • Generate spring client with OpenAPI
      • Navigate to localhost:8080
      • Try to execute getTasks request with default values

      Expected result:
      [curl -X GET "http://localhost:8080/engine-rest/task" -H "accept: application/json"

      Observed:
      curl -X GET "http://localhost:8080/engine-rest/task?withoutTenantId=false&includeAssignedTasks=false&assigned=false&unassigned=false&withCandidateGroups=false&withoutCandidateGroups=false&withCandidateUsers=false&withoutCandidateUsers=false&active=false&suspended=false&variableNamesIgnoreCase=false&variableValuesIgnoreCase=false" -H "accept: application/json"

      Hint: false should be set as a default value for booleans

      AT:

      • remove default values if there are not required across all available endpoints.
      • update the openapi readme with best-practice instructions

        This is the controller panel for Smart Panels app

              Unassigned Unassigned
              yana.vasileva Yana Vasileva
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: