Skip to content

Commit d990121

Browse files
MaggieKimani1MaggieKimani1
committed
chore: address PR comments
1 parent 2133509 commit d990121

26 files changed

+78
-166
lines changed

‎src/Microsoft.OpenApi/Any/OpenApiAny.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@ namespace Microsoft.OpenApi.Any
1212
/// </summary>
1313
public class OpenApiAny : IOpenApiElement, IOpenApiExtension
1414
{
15-
private readonly JsonNode? jsonNode;
15+
private readonly JsonNode jsonNode;
1616

1717
/// <summary>
1818
/// Initializes the <see cref="OpenApiAny"/> class.
1919
/// </summary>
2020
/// <param name="jsonNode"></param>
21-
public OpenApiAny(JsonNode? jsonNode)
21+
public OpenApiAny(JsonNode jsonNode)
2222
{
2323
this.jsonNode = jsonNode;
2424
}
2525

2626
/// <summary>
2727
/// Gets the underlying JsonNode.
2828
/// </summary>
29-
public JsonNode? Node { get { return jsonNode; } }
29+
public JsonNode Node { get { return jsonNode; } }
3030

3131
/// <summary>
3232
/// Writes out the OpenApiAny type.

‎src/Microsoft.OpenApi/Attributes/DisplayAttribute.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ public class DisplayAttribute : Attribute
1515
/// Initializes a new instance of the <see cref="DisplayAttribute"/> class.
1616
/// </summary>
1717
/// <param name="name">The display name.</param>
18-
public DisplayAttribute(string? name)
18+
public DisplayAttribute(string name)
1919
{
2020
Name = Utils.CheckArgumentNullOrEmpty(name);
2121
}
2222

2323
/// <summary>
2424
/// The display Name.
2525
/// </summary>
26-
public string? Name { get; }
26+
public string Name { get; }
2727
}
2828
}

‎src/Microsoft.OpenApi/Exceptions/OpenApiReaderException.cs‎

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,6 @@ public OpenApiReaderException(string message, ParsingContext context) : base(mes
3434
Pointer = context.GetLocation();
3535
}
3636

37-
/// <summary>
38-
/// Initializes the <see cref="OpenApiReaderException"/> class with a message and line, column location of error.
39-
/// </summary>
40-
/// <param name="message">Plain text error message for this exception.</param>
41-
/// <param name="node">Parsing node where error occured</param>
42-
public OpenApiReaderException(string message, JsonNode? node) : base(message)
43-
{
44-
// This only includes line because using a char range causes tests to break due to CR/LF & LF differences
45-
// See https://tools.ietf.org/html/rfc5147 for syntax
46-
}
47-
4837
/// <summary>
4938
/// Initializes the <see cref="OpenApiReaderException"/> class with a custom message and inner exception.
5039
/// </summary>

‎src/Microsoft.OpenApi/Exceptions/OpenApiUnsupportedSpecVersionException.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public class OpenApiUnsupportedSpecVersionException : Exception
1818
/// Initializes the <see cref="OpenApiUnsupportedSpecVersionException"/> class with a specification version.
1919
/// </summary>
2020
/// <param name="specificationVersion">Version that caused this exception to be thrown.</param>
21-
public OpenApiUnsupportedSpecVersionException(string? specificationVersion)
21+
public OpenApiUnsupportedSpecVersionException(string specificationVersion)
2222
: base(string.Format(CultureInfo.InvariantCulture, messagePattern, specificationVersion))
2323
{
2424
this.SpecificationVersion = specificationVersion;
@@ -39,6 +39,6 @@ public OpenApiUnsupportedSpecVersionException(string specificationVersion, Excep
3939
/// <summary>
4040
/// The unsupported specification version.
4141
/// </summary>
42-
public string? SpecificationVersion { get; }
42+
public string SpecificationVersion { get; }
4343
}
4444
}

‎src/Microsoft.OpenApi/Models/OpenApiOperation.cs‎

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -245,27 +245,21 @@ public void SerializeAsV2(IOpenApiWriter writer)
245245
if (consumes.Count > 0)
246246
{
247247
// This is form data. We need to split the request body into multiple parameters.
248-
if (consumes.Contains("application/x-www-form-urlencoded") ||
249-
consumes.Contains("multipart/form-data"))
248+
if ((consumes.Contains("application/x-www-form-urlencoded") ||
249+
consumes.Contains("multipart/form-data")) &&
250+
RequestBody.ConvertToFormDataParameters(writer) is { } formDataParameters)
250251
{
251-
if (RequestBody.ConvertToFormDataParameters(writer) is {} formDataParameters)
252-
{
253-
parameters.AddRange(formDataParameters);
254-
}
252+
parameters.AddRange(formDataParameters);
255253
}
256-
else
254+
else if (RequestBody.ConvertToBodyParameter(writer) is { } bodyParameter)
257255
{
258-
var bodyParameter = RequestBody.ConvertToBodyParameter(writer);
259-
if (bodyParameter != null)
260-
{
261-
parameters.Add(bodyParameter);
262-
}
256+
parameters.Add(bodyParameter);
263257
}
264258
}
265-
else if (RequestBody is OpenApiRequestBodyReference requestBodyReference)
259+
else if (RequestBody is OpenApiRequestBodyReference requestBodyReference && requestBodyReference.Reference.Id is not null)
266260
{
267261
parameters.Add(
268-
new OpenApiParameterReference(requestBodyReference.Reference?.Id, requestBodyReference.Reference?.HostDocument));
262+
new OpenApiParameterReference(requestBodyReference.Reference.Id, requestBodyReference.Reference.HostDocument));
269263
}
270264

271265
if (consumes.Count > 0)

‎src/Microsoft.OpenApi/Models/OpenApiReference.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ public void SerializeAsV2(IOpenApiWriter writer)
246246
{
247247
if (Id is not null)
248248
{
249-
return ExternalResource + "#/" + GetReferenceTypeNameAsV2((ReferenceType)Type) + "/" + Id;
249+
return ExternalResource + "#/" + GetReferenceTypeNameAsV2(Type) + "/" + Id;
250250
}
251251

252252
return ExternalResource;

‎src/Microsoft.OpenApi/Models/References/BaseOpenApiReferenceHolder.cs‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ public virtual T? Target
1515
{
1616
get
1717
{
18-
return Reference?.HostDocument?.ResolveReferenceTo<T>(Reference);
18+
return Reference.HostDocument?.ResolveReferenceTo<T>(Reference);
1919
}
2020
}
21+
2122
/// <summary>
2223
/// Copy constructor
2324
/// </summary>
@@ -40,7 +41,7 @@ protected BaseOpenApiReferenceHolder(BaseOpenApiReferenceHolder<T, V> source)
4041
/// 1. a absolute/relative file path, for example: ../commons/pet.json
4142
/// 2. a Url, for example: http://localhost/pet.json
4243
/// </param>
43-
protected BaseOpenApiReferenceHolder(string? referenceId, OpenApiDocument? hostDocument, ReferenceType referenceType, string? externalResource)
44+
protected BaseOpenApiReferenceHolder(string referenceId, OpenApiDocument? hostDocument, ReferenceType referenceType, string? externalResource)
4445
{
4546
Utils.CheckArgumentNullOrEmpty(referenceId);
4647
// we're not checking for null hostDocument as it's optional and can be set via additional methods by a walker
@@ -56,14 +57,15 @@ protected BaseOpenApiReferenceHolder(string? referenceId, OpenApiDocument? hostD
5657
}
5758
/// <inheritdoc/>
5859
public bool UnresolvedReference { get => Reference is null || Target is null; }
60+
5961
/// <inheritdoc/>
6062
public OpenApiReference Reference { get; init; }
6163
/// <inheritdoc/>
6264
public abstract V CopyReferenceAsTargetElementWithOverrides(V source);
6365
/// <inheritdoc/>
6466
public virtual void SerializeAsV3(IOpenApiWriter writer)
6567
{
66-
if (Reference is not null && !writer.GetSettings().ShouldInlineReference(Reference))
68+
if (!writer.GetSettings().ShouldInlineReference(Reference))
6769
{
6870
Reference.SerializeAsV3(writer);
6971
}
@@ -76,7 +78,7 @@ public virtual void SerializeAsV3(IOpenApiWriter writer)
7678
/// <inheritdoc/>
7779
public virtual void SerializeAsV31(IOpenApiWriter writer)
7880
{
79-
if (Reference is not null && !writer.GetSettings().ShouldInlineReference(Reference))
81+
if (!writer.GetSettings().ShouldInlineReference(Reference))
8082
{
8183
Reference.SerializeAsV31(writer);
8284
}
@@ -89,7 +91,7 @@ public virtual void SerializeAsV31(IOpenApiWriter writer)
8991
/// <inheritdoc/>
9092
public virtual void SerializeAsV2(IOpenApiWriter writer)
9193
{
92-
if (Reference is not null && !writer.GetSettings().ShouldInlineReference(Reference))
94+
if (!writer.GetSettings().ShouldInlineReference(Reference))
9395
{
9496
Reference.SerializeAsV2(writer);
9597
}

‎src/Microsoft.OpenApi/Models/References/OpenApiCallbackReference.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public override IOpenApiCallback CopyReferenceAsTargetElementWithOverrides(IOpen
5353
public override void SerializeAsV2(IOpenApiWriter writer)
5454
{
5555
// examples components are not supported in OAS 2.0
56-
Reference?.SerializeAsV2(writer);
56+
Reference.SerializeAsV2(writer);
5757
}
5858

5959
/// <inheritdoc/>

‎src/Microsoft.OpenApi/Models/References/OpenApiExampleReference.cs‎

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -39,27 +39,15 @@ private OpenApiExampleReference(OpenApiExampleReference example):base(example)
3939
/// <inheritdoc/>
4040
public string? Description
4141
{
42-
get => string.IsNullOrEmpty(Reference?.Description) ? Target?.Description : Reference?.Description;
43-
set
44-
{
45-
if (Reference is not null)
46-
{
47-
Reference.Description = value;
48-
}
49-
}
42+
get => string.IsNullOrEmpty(Reference.Description) ? Target?.Description : Reference.Description;
43+
set => Reference.Description = value;
5044
}
5145

5246
/// <inheritdoc/>
5347
public string? Summary
5448
{
55-
get => string.IsNullOrEmpty(Reference?.Summary) ? Target?.Summary : Reference?.Summary;
56-
set
57-
{
58-
if (Reference is not null)
59-
{
60-
Reference.Summary = value;
61-
}
62-
}
49+
get => string.IsNullOrEmpty(Reference.Summary) ? Target?.Summary : Reference.Summary;
50+
set => Reference.Summary = value;
6351
}
6452

6553
/// <inheritdoc/>
@@ -81,7 +69,7 @@ public override IOpenApiExample CopyReferenceAsTargetElementWithOverrides(IOpenA
8169
public override void SerializeAsV2(IOpenApiWriter writer)
8270
{
8371
// examples components are not supported in OAS 2.0
84-
Reference?.SerializeAsV2(writer);
72+
Reference.SerializeAsV2(writer);
8573
}
8674

8775
/// <inheritdoc/>

‎src/Microsoft.OpenApi/Models/References/OpenApiHeaderReference.cs‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,8 @@ private OpenApiHeaderReference(OpenApiHeaderReference header):base(header)
3939
/// <inheritdoc/>
4040
public string? Description
4141
{
42-
get => string.IsNullOrEmpty(Reference?.Description) ? Target?.Description : Reference?.Description;
43-
set
44-
{
45-
if (Reference is not null)
46-
{
47-
Reference.Description = value;
48-
}
49-
}
42+
get => string.IsNullOrEmpty(Reference.Description) ? Target?.Description : Reference.Description;
43+
set => Reference.Description = value;
5044
}
5145

5246
/// <inheritdoc/>

0 commit comments

Comments
 (0)