Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions src/Microsoft.OpenApi/Extensions/OpenAPIWriterExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,13 @@ internal static OpenApiWriterSettings GetSettings(this IOpenApiWriter openApiWri
}
return new();
}

internal static void CountInlineReference(this IOpenApiWriter openApiWriter)
{
if (openApiWriter is OpenApiWriterBase @base)
{
@base.CountInlineReference();
}
}
}
}
9 changes: 7 additions & 2 deletions src/Microsoft.OpenApi/Models/OpenApiHeader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ public virtual void SerializeAsV3(IOpenApiWriter writer)
SerializeInternal(writer, OpenApiSpecVersion.OpenApi3_0, (writer, element) => element.SerializeAsV3(writer));
}

internal void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version,
internal void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version,
Action<IOpenApiWriter, IOpenApiSerializable> callback)
{
Utils.CheckArgumentNull(writer);
Expand Down Expand Up @@ -167,7 +167,12 @@ public virtual void SerializeAsV2(IOpenApiWriter writer)
writer.WriteProperty(OpenApiConstants.AllowReserved, AllowReserved, false);

// schema
var targetSchema = Schema switch {
if (Schema is OpenApiSchemaReference)
{
writer.CountInlineReference();
}
var targetSchema = Schema switch
{
OpenApiSchemaReference schemaReference => schemaReference.RecursiveTarget,
OpenApiSchema schema => schema,
_ => null,
Expand Down
9 changes: 7 additions & 2 deletions src/Microsoft.OpenApi/Models/OpenApiParameter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
SerializeInternal(writer, OpenApiSpecVersion.OpenApi3_0, (writer, element) => element.SerializeAsV3(writer));
}

internal void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version,
internal void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version,
Action<IOpenApiWriter, IOpenApiSerializable> callback)
{
Utils.CheckArgumentNull(writer);
Expand Down Expand Up @@ -175,7 +175,7 @@
/// </summary>
/// <param name="writer">Writer to use for the serialization</param>
/// <param name="extensionsClone">Extensions clone</param>
internal virtual void WriteRequestBodySchemaForV2(IOpenApiWriter writer, Dictionary<string, IOpenApiExtension>? extensionsClone)

Check failure on line 178 in src/Microsoft.OpenApi/Models/OpenApiParameter.cs

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 25 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=microsoft_OpenAPI.NET&issues=AaFVGz8Aqr14z2r9FeCO&open=AaFVGz8Aqr14z2r9FeCO&pullRequest=3125
{
// In V2 parameter's type can't be a reference to a custom object schema or can't be of type object
// So in that case map the type as string.
Expand All @@ -202,7 +202,12 @@
// uniqueItems
// enum
// multipleOf
var targetSchema = Schema switch {
if (Schema is OpenApiSchemaReference)
{
writer.CountInlineReference();
}
var targetSchema = Schema switch
{
OpenApiSchemaReference schemaReference => schemaReference.RecursiveTarget,
OpenApiSchema schema => schema,
_ => null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ protected BaseOpenApiReferenceHolder(string referenceId, OpenApiDocument? hostDo
/// <inheritdoc/>
public virtual void SerializeAsV3(IOpenApiWriter writer)
{
if (!writer.GetSettings().ShouldInlineReference(Reference)
if (!writer.GetSettings().ShouldInlineReference(Reference)
|| Reference.Type == ReferenceType.Tag) // tags are held as references need to drop in.
{
Reference.SerializeAsV3(writer);
Expand Down Expand Up @@ -254,6 +254,7 @@ private protected void SerializeInternal(IOpenApiWriter writer,
Action<IOpenApiWriter, U> action)
{
Utils.CheckArgumentNull(writer);
writer.CountInlineReference();
ApplyToTarget(element => action(writer, element));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ public override void SerializeAsV2(IOpenApiWriter writer)
{
if (writer.GetSettings().ShouldInlineReference(Reference))
{
writer.CountInlineReference();
return GetFromTarget(target => target.ConvertToBodyParameter(writer));
}

Expand All @@ -74,6 +75,7 @@ public override void SerializeAsV2(IOpenApiWriter writer)
{
if (writer.GetSettings().ShouldInlineReference(Reference))
{
writer.CountInlineReference();
return GetFromTarget(target => target.ConvertToFormDataParameters(writer));
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -250,8 +250,14 @@ private void SerializeAsWithoutLoops(IOpenApiWriter writer, Action<IOpenApiWrite
}
else
{
SerializeInternal(writer, (w, element) => action(w, element));
writer.GetSettings().LoopDetector.PopLoop<IOpenApiSchema>();
try
{
SerializeInternal(writer, (w, element) => action(w, element));
}
finally
{
writer.GetSettings().LoopDetector.PopLoop<IOpenApiSchema>();
}
}

}
Expand Down
9 changes: 9 additions & 0 deletions src/Microsoft.OpenApi/Properties/SRResource.Designer.cs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions src/Microsoft.OpenApi/Properties/SRResource.resx
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,9 @@
<data name="IndentationLevelInvalid" xml:space="preserve">
<value>Indentation level cannot be lower than 0.</value>
</data>
<data name="MaximumInlineReferenceCountExceeded" xml:space="preserve">
<value>The maximum number of inline references ({0}) has been exceeded.</value>
</data>
<data name="InputItemShouldBeType" xml:space="preserve">
<value>The input item should be in type of '{0}'.</value>
</data>
Expand Down
2 changes: 2 additions & 0 deletions src/Microsoft.OpenApi/PublicAPI.Unshipped.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
#nullable enable
Microsoft.OpenApi.OpenApiDocument.GetOperationById(string! operationId) -> Microsoft.OpenApi.OpenApiOperation?
Microsoft.OpenApi.OpenApiWriterSettings.MaxInlineReferenceCount.get -> int
Microsoft.OpenApi.OpenApiWriterSettings.MaxInlineReferenceCount.set -> void
17 changes: 16 additions & 1 deletion src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ public abstract class OpenApiWriterBase : IOpenApiWriter
/// Number which specifies the level of indentation.
/// </summary>
private int _indentLevel;
private int _inlineReferenceCount;

/// <summary>
/// Initializes a new instance of the <see cref="OpenApiWriterBase"/> class.
Expand Down Expand Up @@ -70,6 +71,20 @@ protected OpenApiWriterBase(TextWriter textWriter, OpenApiWriterSettings? settin
/// </summary>
protected TextWriter Writer { get; }

internal void CountInlineReference()
{
if (_inlineReferenceCount >= Settings.MaxInlineReferenceCount)
{
throw new OpenApiWriterException(
string.Format(
CultureInfo.InvariantCulture,
SRResource.MaximumInlineReferenceCountExceeded,
Settings.MaxInlineReferenceCount));
}

_inlineReferenceCount++;
}

/// <summary>
/// Write start object.
/// </summary>
Expand Down Expand Up @@ -319,7 +334,7 @@ public virtual void WriteIndentation()
Writer.Write(IndentationString);
}
}

/// <summary>
/// Get current scope.
/// </summary>
Expand Down
9 changes: 9 additions & 0 deletions src/Microsoft.OpenApi/Writers/OpenApiWriterSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
/// </summary>
public class OpenApiWriterSettings
{
private const int DefaultMaxInlineReferenceCount = 10_000;

internal LoopDetector LoopDetector { get; } = new();

/// <summary>
/// Indicates if local references should be rendered as an inline object
/// </summary>
Expand All @@ -16,6 +19,12 @@ public class OpenApiWriterSettings
/// </summary>
public bool InlineExternalReferences { get; set; }

/// <summary>
/// Gets or sets the maximum number of references that can be expanded inline by a writer.
/// </summary>
/// <remarks>The default is 10,000.</remarks>
public int MaxInlineReferenceCount { get; set; } = DefaultMaxInlineReferenceCount;

internal bool ShouldInlineReference(BaseOpenApiReference reference)
{
return (reference.IsLocal && InlineLocalReferences)
Expand Down
Loading
Loading