Skip to content

Do not ignore multiple types when serializing to 3.0 #2960

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

Do not ignore multiple types when serializing to 3.0 #2960

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/Extensions/OpenApiTypeMapper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,12 @@ internal static string ToFirstIdentifier(this JsonSchemaType schemaType)
/// <returns></returns>
internal static string ToSingleIdentifier(this JsonSchemaType schemaType)
{
return schemaType.ToIdentifiersInternal().Single();
if (allSchemaTypes.TryGetValue(schemaType, out var schemaTypeString))
{
return schemaTypeString;
}

throw new InvalidOperationException($"ToSingleIdentifier is called with unexpected value '{schemaType}'. Callers must ensure this is called with a valid single value JsonSchemaType.");
}

/// <summary>
Expand Down
140 changes: 100 additions & 40 deletions src/Microsoft.OpenApi/Models/OpenApiSchema.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ namespace Microsoft.OpenApi
/// </summary>
public class OpenApiSchema : IOpenApiExtensible, IOpenApiSchema, IOpenApiSchemaMissingProperties, IOpenApiSchemaWithUnevaluatedProperties, IMetadataContainer
{
private static readonly IEnumerable<JsonNode> s_singleNullElementList = [ JsonNullSentinel.JsonNull ];
private static readonly IEnumerable<JsonNode> s_singleNullElementList = [JsonNullSentinel.JsonNull];

/// <inheritdoc />
public string? Title { get; set; }
Expand Down Expand Up @@ -549,7 +549,7 @@ private void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version
}

// type
var serializedTypeProperty = TrySerializeTypeProperty(writer, version);
var serializedTypeProperty = TrySerializeTypePropertyForVersion3AndLater(writer, version, callback);

// allOf
writer.WriteOptionalCollection(OpenApiConstants.AllOf, AllOf, callback);
Expand Down Expand Up @@ -681,7 +681,7 @@ internal void WriteJsonSchemaKeywords(IOpenApiWriter writer, Action<IOpenApiWrit
writer.WriteProperty(OpenApiConstants.Id, Id);
writer.WriteProperty(OpenApiConstants.DollarSchema, Schema?.ToString());
writer.WriteProperty(OpenApiConstants.Comment, Comment);

if (WasConstExplicitlySet)
{
writer.WriteRequiredProperty(OpenApiConstants.Const, Const);
Expand All @@ -692,7 +692,7 @@ internal void WriteJsonSchemaKeywords(IOpenApiWriter writer, Action<IOpenApiWrit
writer.WriteProperty(OpenApiConstants.Anchor, Anchor);
writer.WriteProperty(OpenApiConstants.DynamicRef, DynamicRef);
writer.WriteProperty(OpenApiConstants.DynamicAnchor, DynamicAnchor);

// UnevaluatedProperties: similar to AdditionalProperties, serialize as schema if present, else as boolean.
// Only emit when the type could include objects.
// Skip when type is explicitly set to a non-object type (array, string, number, integer, boolean, null).
Expand Down Expand Up @@ -833,7 +833,7 @@ private void SerializeAsV2(
writer.WriteStartObject();

// type
TrySerializeTypeProperty(writer, OpenApiSpecVersion.OpenApi2_0);
TrySerializeTypePropertyForVersion2(writer);

// description
writer.WriteProperty(OpenApiConstants.Description, Description);
Expand Down Expand Up @@ -915,7 +915,7 @@ private void SerializeAsV2(
// oneOf (Not Supported in V2) - Write the first schema only as an allOf.
writer.WriteOptionalCollection(OpenApiConstants.AllOf, OneOf?.Take(1), (w, s) => s.SerializeAsV2(w));
}
#pragma warning restore CS0618
#pragma warning restore CS0618
}

// properties
Expand Down Expand Up @@ -996,32 +996,113 @@ private void SerializeAsV2(
writer.WriteEndObject();
}

private bool TrySerializeTypeProperty(IOpenApiWriter writer, OpenApiSpecVersion version, JsonSchemaType? inferredType = null)
private bool TrySerializeTypePropertyForVersion2(IOpenApiWriter writer)
{
// Use original type or inferred type when the explicit type is not set
var typeToUse = Type ?? inferredType;
if (Type is not { } type)
{
return false;
}

if (typeToUse is null)
var typeWithoutNull = type & ~JsonSchemaType.Null;
if (typeWithoutNull != 0 && !HasMultipleTypes(typeWithoutNull))
{
writer.WriteProperty(OpenApiConstants.Type, typeWithoutNull.ToFirstIdentifier());
return true;
}

return false;
}

/// <summary>
/// Tries to serialize the "type" property for OpenAPI v3 and later versions.
/// </summary>
/// <returns>
/// true if the Type was serializable using "type" property, and false if
/// it serialized using anyOf/oneOf or if it couldn't be serialized at all.
/// </returns>
private bool TrySerializeTypePropertyForVersion3AndLater(IOpenApiWriter writer, OpenApiSpecVersion version, Action<IOpenApiWriter, IOpenApiSerializable> callback)
{
if (Type is not { } type)
{
return false;
}

switch (version)
if (version == OpenApiSpecVersion.OpenApi3_0)
{
case OpenApiSpecVersion.OpenApi2_0 or OpenApiSpecVersion.OpenApi3_0:
var typeWithoutNull = typeToUse.Value & ~JsonSchemaType.Null;
if (typeWithoutNull != 0 && !HasMultipleTypes(typeWithoutNull))
if (type == JsonSchemaType.Null)
{
return false;
}

var typeWithoutNull = type & ~JsonSchemaType.Null;
var hasNull = typeWithoutNull != type;
var arrayWithoutNull = (from JsonSchemaType flag in jsonSchemaTypeValues
where typeWithoutNull.HasFlag(flag)
select flag).ToArray();

// - If we have more than one type (excluding null), we have to use anyOf/oneOf.
// - If we have exactly one type alone (without null), we emit the type property.
// - If we have exactly one non-null type and also we have the null type, we emit the type property and nullable: true (handled in SerializeNullable)
if (arrayWithoutNull.Length > 1)
{
// If the schema doesn't already have anyOf/oneOf, we can write multiple types as such.
var canWriteAsAnyOf = AnyOf is not { Count: > 0 };
var canWriteAsOneOf = OneOf is not { Count: > 0 };
if (canWriteAsAnyOf)
{
writer.WriteOptionalCollection(OpenApiConstants.AnyOf, ConstructChildSchemasForTypes(arrayWithoutNull, hasNull), callback);
return false;
}
else if (canWriteAsOneOf)
{
writer.WriteProperty(OpenApiConstants.Type, typeWithoutNull.ToFirstIdentifier());
return true;
writer.WriteOptionalCollection(OpenApiConstants.OneOf, ConstructChildSchemasForTypes(arrayWithoutNull, hasNull), callback);
return false;
}
break;
default:
WriteUnifiedSchemaType(typeToUse.Value, writer);
}
else
{
writer.WriteProperty(OpenApiConstants.Type, arrayWithoutNull[0].ToSingleIdentifier());
return true;
}
}
else
{
var array = (from JsonSchemaType flag in jsonSchemaTypeValues
where type.HasFlag(flag)
select flag).ToArray();

if (array.Length > 1)
{
writer.WriteOptionalCollection(OpenApiConstants.Type, array, (w, s) => w.WriteValue(s.ToSingleIdentifier()));
}
else
{
writer.WriteProperty(OpenApiConstants.Type, array[0].ToSingleIdentifier());
}

return true;
}

return false;

static OpenApiSchema[] ConstructChildSchemasForTypes(JsonSchemaType[] types, bool hasNull)
{
var schemas = new OpenApiSchema[types.Length + (hasNull ? 1 : 0)];
for (int i = 0; i < types.Length; i++)
{
schemas[i] = new OpenApiSchema()
{
Type = types[i]
};
}

if (hasNull)
{
schemas[schemas.Length - 1] = new OpenApiSchema() { Type = JsonSchemaType.Null };
}

return schemas;
}
}

private static bool IsPowerOfTwo(int x)
Expand All @@ -1035,27 +1116,6 @@ private static bool HasMultipleTypes(JsonSchemaType schemaType)
return !IsPowerOfTwo(schemaTypeNumeric);
}

private static void WriteUnifiedSchemaType(JsonSchemaType type, IOpenApiWriter writer)
{
var array = (from JsonSchemaType flag in jsonSchemaTypeValues
where type.HasFlag(flag)
select flag.ToFirstIdentifier()).ToArray();
if (array.Length > 1)
{
writer.WriteOptionalCollection(OpenApiConstants.Type, array, (w, s) =>
{
if (!string.IsNullOrEmpty(s) && s is not null)
{
w.WriteValue(s);
}
});
}
else
{
writer.WriteProperty(OpenApiConstants.Type, array[0]);
}
}

private void SerializeNullable(IOpenApiWriter writer, OpenApiSpecVersion version)
{
if (HasNullType)
Expand Down
Loading