Skip to content

fix(v2): map OpenAPI 2.0 response schema type file to binary format (#3150) #3151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Vincent Biret (baywet) wants to merge 1 commit into
base: support/v2
Choose a base branch
from
Open

fix(v2): map OpenAPI 2.0 response schema type file to binary format (#3150) #3151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/Microsoft.OpenApi/Reader/V2/OpenApiSchemaDeserializer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

using System;
Expand All @@ -20,7 +20,7 @@
{
private const string EncounteredNullableExtensionTrueMetadataKey = "encounteredNullable";

private static readonly FixedFieldMap<OpenApiSchema> _openApiSchemaFixedFields = new()

Check failure on line 23 in src/Microsoft.OpenApi/Reader/V2/OpenApiSchemaDeserializer.cs

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Refactor this field to reduce its Cognitive Complexity from 41 to the 15 allowed. 


See more on https://sonarcloud.io/project/issues?id=microsoft_OpenAPI.NET&issues=AaF-5NF_NyFchgfNN3d9&open=AaF-5NF_NyFchgfNN3d9&pullRequest=3151
{
{
"title",
Expand Down Expand Up @@ -170,6 +170,11 @@
if (type != null)
{
o.Type = type.ToJsonSchemaType();
// OpenAPI 2.0 response schema allows type: file, which maps to format: binary in OpenAPI 3.x
if ("file".Equals(type, StringComparison.OrdinalIgnoreCase))
{
o.Format = "binary";
}
}
}
},
Expand Down
37 changes: 36 additions & 1 deletion test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiSchemaTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

using System.Collections.Generic;
Expand Down Expand Up @@ -186,5 +186,40 @@ public async Task SerializeSchemaWithOnlyNullableShouldSucceed()

Assert.Equal(expected.MakeLineBreaksEnvironmentNeutral(), schemaString.MakeLineBreaksEnvironmentNeutral());
}

[Fact]
public void ParseSchemaWithTypeFileShouldSetTypeStringAndFormatBinary()
{
// Arrange
var node = JsonNode.Parse("{\"type\": \"file\"}");

// Act
var schema = OpenApiV2Deserializer.LoadSchema(node, new(), new ParsingContext(new()));

// Assert
Assert.NotNull(schema);
Assert.Equal(JsonSchemaType.String, schema.Type);
Assert.Equal("binary", schema.Format);
}

[Fact]
public void ParseResponseSchemaWithTypeFileShouldSetTypeStringAndFormatBinary()
{
// Arrange
var node = JsonNode.Parse("{\"produces\": [\"application/octet-stream\"], \"responses\": {\"200\": {\"description\": \"File response\", \"schema\": {\"type\": \"file\"}}}}");

// Act
var operation = OpenApiV2Deserializer.LoadOperation(node, new(), new ParsingContext(new()));

// Assert
Assert.NotNull(operation);
Assert.NotNull(operation.Responses);
var response = Assert.IsType<OpenApiResponse>(operation.Responses["200"]);
Assert.NotNull(response.Content);
var mediaType = Assert.Single(response.Content.Values);
Assert.NotNull(mediaType.Schema);
Assert.Equal(JsonSchemaType.String, mediaType.Schema.Type);
Assert.Equal("binary", mediaType.Schema.Format);
}
}
}
Loading