Support OAS 3 - Operation Parameter Serialization for Complex Objects

OpenAPI 3.0 supports arrays and objects in operation parameters (path, query, header, and cookie) and lets you specify how these parameters should be serialized. The serialization method is defined by the style and explode keywords:

• style defines how multiple values are delimited. Possible styles depend on the parameter location – path, query, header or cookie.
• explode (true/false) specifies whether arrays and objects should generate separate parameters for each array item or object property.

Details: https://swagger.io/docs/specification/serialization/

NSwag will need to understand when complex objects are in an operation parameter and apply the “Simple” style and set explode to “false” in the resultant spec. There will also need to be some configuration options for users to select different “style” and “explode” defaults.

[more-urgent-jest]

I am trying define a query parameter using a schema like so:

    "/path/to/here": {
      "get": {
        "summary": "get to here",
        "responses": {
          "200": {
            "$ref": "#/components/responses/Response"
          }
        },
        "operationId": "get-to-here",
        "description": "Get to here",
        "parameters": [
          {
            "schema": {
              "$ref": "#/components/schemas/Request"
            },
            "in": "query",
            "name": "Request",
            "description": "Request for here",
            "required": true,
            "explode": true
          }
        ],
        "tags": [
          "Here"
        ]
      }
    }

but when the C# client is built from this via an Open API service reference using the output is:

        public virtual async Task<Response> GetToHereAsync(Request request, CancellationToken cancellationToken)
        {
            if (request == null)
                throw new System.ArgumentNullException("request");

            var urlBuilder_ = new System.Text.StringBuilder();
            urlBuilder_.Append(BaseUrl != null ? BaseUrl.TrimEnd('/') : "").Append("/path/to/here?");
            foreach (var item_ in Request.AdditionalProperties) { urlBuilder_.Append(System.Uri.EscapeDataString(item_.Key) + "=").Append(System.Uri.EscapeDataString(ConvertToString(item_.Value, System.Globalization.CultureInfo.InvariantCulture))).Append("&"); }
            urlBuilder_.Length--;

why is this only exploding the additional properties and doing so on the type rather than the parameter which doesn’t compile since the Request is not a static type?

[more-urgent-jest]

ah, jeez, changing the name property to “name”: “request” fixes that.