-
Type:
Task
-
Resolution: Unresolved
-
Priority:
L3 - Default
-
None
-
Affects Version/s: None
-
Component/s: 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):
- 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 example table
- style: form, explode: false from the example table