Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Unexpected 'collectionFormat' writing Swagger 2 #1053

Copy link
Copy link
@richardkaspar

Description

@richardkaspar
Issue body actions

Describe the bug
Writing a Swagger 2 file with parameter differ between Microsoft.OpenApi.Readers 1.3.2 and Microsoft.OpenApi.Readers 1.4.1.

To Reproduce

Use the following code with Microsoft.OpenApi.Readers 1.3.2 and Microsoft.OpenApi.Readers 1.4.1.

var doc = new OpenApiDocument
{
    Paths = new OpenApiPaths
    {
        ["/foo"] = new()
        {
            Operations = new ConcurrentDictionary<OperationType, OpenApiOperation>
            {
                [OperationType.Get] = new()
                {
                    Parameters = new List<OpenApiParameter>
                    {
                        new()
                        {
                            In = ParameterLocation.Query,
                            Schema = new OpenApiSchema{Type = "string"}
                        }
                    }
                }
            }
        }
    }
};
var sb     = new StringBuilder();
var writer = new OpenApiYamlWriter(new StringWriter(sb, new CultureInfo("en_us")));

doc.SerializeAsV2(writer);

File.WriteAllText(writeFile, sb.ToString());

Microsoft.OpenApi.Readers 1.3.2:

swagger: '2.0'
info: { }
paths:
  /foo:
    get:
      parameters:
        - in: query
          type: string
      responses: { }

Microsoft.OpenApi.Readers 1.4.1:

swagger: '2.0'
info: { }
paths:
  /foo:
    get:
      parameters:
        - in: query
          type: string
          collectionFormat: multi
      responses: { }

Expected behavior
'collectionFormat' should not be written.

Screenshots/Code Snippets
grafik

Additional context
https://swagger.io/docs/specification/2-0/describing-parameters/
grafik

Reactions are currently unavailable

Metadata

Metadata

Assignees

Labels

type:bugA broken experienceA broken experience

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    Morty Proxy This is a proxified and sanitized view of the page, visit original site.