Skip to content

Swtich reference id type names and remove underscore for dictionary and list to comply OpenApi Spec #593

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Swtich reference id type names and remove underscore for dictionary and list to comply OpenApi Spec #593

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
10 changes: 5 additions & 5 deletions src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Extensions/TypeExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,19 +402,19 @@ public static string GetOpenApiReferenceId(this Type type, bool isDictionary, bo

if (isDictionary)
{
var name = type.Name.EndsWith("[]") ? "Dictionary_" + type.GetOpenApiSubTypeName(namingStrategy) : type.Name.Split('`').First() + "_" + type.GetOpenApiSubTypeName(namingStrategy);
var name = type.Name.EndsWith("[]") ? type.GetOpenApiSubTypeName(namingStrategy) + "Dictionary" : type.GetOpenApiSubTypeName(namingStrategy) + type.Name.Split('`').First();
return namingStrategy.GetPropertyName(name, hasSpecifiedName: false);
}
if (isList)
{
var name = type.Name.EndsWith("[]") ? "List_" + type.GetOpenApiSubTypeName(namingStrategy) : type.Name.Split('`').First() + "_" + type.GetOpenApiSubTypeName(namingStrategy);
var name = type.Name.EndsWith("[]") ? type.GetOpenApiSubTypeName(namingStrategy) + "List" : type.GetOpenApiSubTypeName(namingStrategy) + type.Name.Split('`').First();
return namingStrategy.GetPropertyName(name, hasSpecifiedName: false);
}

if (type.IsGenericType)
{
return namingStrategy.GetPropertyName(type.Name.Split('`').First(), false) + "_" +
string.Join("_", type.GenericTypeArguments.Select(a => namingStrategy.GetPropertyName(a.Name, false)));
return namingStrategy.GetPropertyName(type.Name.Split('`').First(), false) +
string.Concat( type.GenericTypeArguments.Select(a => namingStrategy.GetPropertyName(a.Name, false)));
}

return namingStrategy.GetPropertyName(type.Name, hasSpecifiedName: false);
Expand Down Expand Up @@ -460,7 +460,7 @@ public static Type GetUnderlyingType(this Type type)
}

if (type.IsOpenApiArray())
{
{
underlyingType = type.GetElementType() ?? type.GetGenericArguments()[0];
}

Expand Down
5 changes: 5 additions & 0 deletions test/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Tests.Fakes/FakeFunctions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,10 @@ public static void GenericMethodOne()
public static void GenericMethodTwo()
{
}

[OpenApiRequestBody(contentType: "application/json", bodyType: typeof(FakeOtherGenericModel<FakeClassModel, FakeOtherClassModel>), Required = true, Description = "Fake list model")]
public static void GenericMethodThree()
{
}
}
}
9 changes: 9 additions & 0 deletions test/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Tests.Fakes/FakeOtherGenericModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
namespace Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Tests.Fakes
{
public class FakeOtherGenericModel<T1, T2>
{
public string Name { get; set; }
public T1 FirstValue { get; set; }
public T2 SecondValue { get; set; }
}
}
48 changes: 30 additions & 18 deletions test/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Tests/DocumentHelperTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public void GetOpenApiSchemas_Result_Should_Contain_Schema_For_Function_Classes(
var schemas = documentHelper.GetOpenApiSchemas(methods, namingStrategy, visitorCollection);

schemas.Should().NotBeNull();
schemas.Count.Should().Be(6);
schemas.Count.Should().Be(7);

schemas.Should().ContainKey("FakeClassModel");

Expand All @@ -65,23 +65,35 @@ public void GetOpenApiSchemas_Result_Should_Contain_Schema_For_Function_Classes(
schemas["FakeStringModel"].Properties.Count.Should().Be(2);
schemas["FakeStringModel"].Type.Should().Be("object");

schemas.Should().ContainKey("FakeGenericModel_FakeClassModel");

schemas["FakeGenericModel_FakeClassModel"].Properties.Count.Should().Be(2);
schemas["FakeGenericModel_FakeClassModel"].Type.Should().Be("object");
schemas["FakeGenericModel_FakeClassModel"].Properties.Should().ContainKey("Name");
schemas["FakeGenericModel_FakeClassModel"].Properties.Should().ContainKey("Value");
schemas["FakeGenericModel_FakeClassModel"].Properties["Value"].Properties.Should().ContainKey("Number");
schemas["FakeGenericModel_FakeClassModel"].Properties["Value"].Properties.Should().ContainKey("Text");

schemas.Should().ContainKey("FakeGenericModel_FakeOtherClassModel");

schemas["FakeGenericModel_FakeOtherClassModel"].Properties.Count.Should().Be(2);
schemas["FakeGenericModel_FakeOtherClassModel"].Type.Should().Be("object");
schemas["FakeGenericModel_FakeOtherClassModel"].Properties.Should().ContainKey("Name");
schemas["FakeGenericModel_FakeOtherClassModel"].Properties.Should().ContainKey("Value");
schemas["FakeGenericModel_FakeOtherClassModel"].Properties["Value"].Properties.Should().ContainKey("FirstName");
schemas["FakeGenericModel_FakeOtherClassModel"].Properties["Value"].Properties.Should().ContainKey("LastName");
schemas.Should().ContainKey("FakeGenericModelFakeClassModel");

schemas["FakeGenericModelFakeClassModel"].Properties.Count.Should().Be(2);
schemas["FakeGenericModelFakeClassModel"].Type.Should().Be("object");
schemas["FakeGenericModelFakeClassModel"].Properties.Should().ContainKey("Name");
schemas["FakeGenericModelFakeClassModel"].Properties.Should().ContainKey("Value");
schemas["FakeGenericModelFakeClassModel"].Properties["Value"].Properties.Should().ContainKey("Number");
schemas["FakeGenericModelFakeClassModel"].Properties["Value"].Properties.Should().ContainKey("Text");

schemas.Should().ContainKey("FakeGenericModelFakeOtherClassModel");

schemas["FakeGenericModelFakeOtherClassModel"].Properties.Count.Should().Be(2);
schemas["FakeGenericModelFakeOtherClassModel"].Type.Should().Be("object");
schemas["FakeGenericModelFakeOtherClassModel"].Properties.Should().ContainKey("Name");
schemas["FakeGenericModelFakeOtherClassModel"].Properties.Should().ContainKey("Value");
schemas["FakeGenericModelFakeOtherClassModel"].Properties["Value"].Properties.Should().ContainKey("FirstName");
schemas["FakeGenericModelFakeOtherClassModel"].Properties["Value"].Properties.Should().ContainKey("LastName");

schemas.Should().ContainKey("FakeOtherGenericModelFakeClassModelFakeOtherClassModel");

schemas["FakeOtherGenericModelFakeClassModelFakeOtherClassModel"].Properties.Count.Should().Be(3);
schemas["FakeOtherGenericModelFakeClassModelFakeOtherClassModel"].Type.Should().Be("object");
schemas["FakeOtherGenericModelFakeClassModelFakeOtherClassModel"].Properties.Should().ContainKey("Name");
schemas["FakeOtherGenericModelFakeClassModelFakeOtherClassModel"].Properties.Should().ContainKey("FirstValue");
schemas["FakeOtherGenericModelFakeClassModelFakeOtherClassModel"].Properties.Should().ContainKey("SecondValue");
schemas["FakeOtherGenericModelFakeClassModelFakeOtherClassModel"].Properties["FirstValue"].Properties.Should().ContainKey("Number");
schemas["FakeOtherGenericModelFakeClassModelFakeOtherClassModel"].Properties["FirstValue"].Properties.Should().ContainKey("Text");
schemas["FakeOtherGenericModelFakeClassModelFakeOtherClassModel"].Properties["SecondValue"].Properties.Should().ContainKey("FirstName");
schemas["FakeOtherGenericModelFakeClassModelFakeOtherClassModel"].Properties["SecondValue"].Properties.Should().ContainKey("LastName");
}

[TestMethod]
Expand Down
2 changes: 1 addition & 1 deletion ....Azure.WebJobs.Extensions.OpenApi.Core.Tests/Visitors/DictionaryObjectTypeVisitorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ public void Given_Type_When_IsPayloadVisitable_Invoked_Then_It_Should_Return_Res
[DataRow(typeof(IReadOnlyDictionary<string, string>), "object", null, "string", false, "string", 0)]
[DataRow(typeof(KeyValuePair<string, string>), "object", null, "string", false, "string", 0)]
[DataRow(typeof(Dictionary<string, FakeModel>), "object", null, "object", true, "fakeModel", 1)]
[DataRow(typeof(Dictionary<string, string[]>), "object", null, "array", true, "list_string", 1)] //
[DataRow(typeof(Dictionary<string, string[]>), "object", null, "array", true, "stringList", 1)] //
[DataRow(typeof(IDictionary<string, FakeModel>), "object", null, "object", true, "fakeModel", 1)]
[DataRow(typeof(IReadOnlyDictionary<string, FakeModel>), "object", null, "object", true, "fakeModel", 1)]
[DataRow(typeof(KeyValuePair<string, FakeModel>), "object", null, "object", true, "fakeModel", 1)]
Expand Down