Forum Discussion

more-urgen-jest's avatar
more-urgen-jest
Occasional Contributor
2 years ago
Solved

c# openapi parameter schema object

is it possible to define a parameter using a ref to a schema? e.g.:     "/path/to/here": { "get": { "responses": { "200": { "$ref": "#/components/responses...
Swagger Codegen
more-urgen-jest's avatar
more-urgen-jest
Occasional Contributor

updating the packages to the latest versions:

 

    <PackageReference Include="NSwag.ApiDescription.Client" Version="13.17.0">

 


resulted in this output:

 

        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--;

 

 

so does that mean that if I want the query parameters to be populated just setting the properties of the object won't do it, I also have to populate AdditionalProperties???

also, it's Request.AdditionalProperties instead of request.AdditionalProperties, which will result in a runtime error?

more-urgen-jest's avatar
more-urgen-jest
Occasional Contributor
2 years ago

when I add "style": "form" I get this:

        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?");
            if (Request.Property1 != null)
            {
                urlBuilder_
					.Append(System.Uri.EscapeDataString("Property1") + "=")
					.Append(System.Uri.EscapeDataString(ConvertToString(Request.Property1, System.Globalization.CultureInfo.InvariantCulture)))
					.Append("&");
            }
            if (Request.Property2 != null)
            {
                urlBuilder_
					.Append(System.Uri.EscapeDataString("Property2") + "=")
					.Append(System.Uri.EscapeDataString(ConvertToString(Request.Property2, System.Globalization.CultureInfo.InvariantCulture)))
					.Append("&");
            }
            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--;

which is what I am trying to get, except for the use of the type again instead of the parameter.

  • more-urgen-jest's avatar
    more-urgen-jest
    Occasional Contributor
    2 years ago

    and changing the parameter name property to lower case, "name": "request", fixes that.

            "parameters": [
          {
            "schema": {
              "$ref": "#/components/schemas/Request"
            },
            "in": "query",
            "name": "request",
            "description": "Request for getting here",
            "required": true,
            "explode": true,
            "style": "form"
          }