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

In OpenAPI, comma-separated list query params are documented as lists

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: L3 - Default L3 - Default
    • None
    • None
    • documentation, engine
    • None

      Current OpenAPI documentation:

      Example from the GetDeployments endpoint:

      {
 "name": "tenantIdIn",
 "in": "query",
 "schema":
{ "type": "string" },
 "description": "Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids."
 }

       

      Acceptance Criteria (Required on creation):

      • Query parameters that are comma-separated string list of items are be documented via styles so that list/array as type is used for more easy/intuitive input of the request parameters.
      • test the requests are valid for the REST API via Swagger UI (encoding) and generated clients (List<String>)

      Hints (Optional):

        This is the controller panel for Smart Panels app

            [CAM-13502] In OpenAPI, comma-separated list query params are documented as lists

              Unassigned Unassigned
              StephenOTT Stephen Russett
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: