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

            Stephen Russett created issue -
            Yana Vasileva made changes -
            Assignee New: Yana Vasileva [ yana.vasileva ]
            Yana Vasileva made changes -
            Mentioned Roles
            Yana Vasileva made changes -
            Mentioned Groups
            Yana Vasileva made changes -
            Link New: This issue is related to CAMTEAM-168 [ CAMTEAM-168 ]
            Yana Vasileva made changes -
            Mentioned Roles
            Yana Vasileva made changes -
            Mentioned Groups
            Yana Vasileva made changes -
            Mentioned Roles
            Yana Vasileva made changes -
            Mentioned Groups
            Yana Vasileva made changes -
            Description Original: 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."
            }

             

            3.0 spec provides the explode options so you can serialize from a list<> into a query param: [https://swagger.io/docs/specification/serialization/]

             

                          		New: h4. Current OpenAPI documentation:
            Example from the GetDeployments endpoint:

            {code:json}
            {
             "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."
             }
            {code}
             
            h4. Acceptance Criteria (Required on creation):
             * Query parameters that are comma-separated list of items can be documented via styles so that list/array 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>)

            h4. Hints (Optional):
            * 3.0 spec provides the explode options so you can serialize from a list<> into a query param: [https://swagger.io/docs/specification/serialization/]
            * OpenAPI spec: https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md#style-values
            ** style: form, explode: false from the examples
             
            Yana Vasileva made changes -
            Mentioned Roles
            Yana Vasileva made changes -
            Mentioned Groups

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

                Created:
                Updated: