Skip to content

Commit 0b67b7c

Browse files
darrelmillerdarrelmiller
committed
Even more cleanup
1 parent 169c94c commit 0b67b7c

File tree

6 files changed

+39
-38
lines changed

6 files changed

+39
-38
lines changed

‎src/Microsoft.OpenApi.Readers/OpenApiStreamReader.cs

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,37 +15,38 @@ namespace Microsoft.OpenApi.Readers
1515
/// </summary>
1616
public class OpenApiStreamReader : IOpenApiReader<Stream, OpenApiDiagnostic>
1717
{
18-
1918

2019
/// <summary>
2120
/// Reads the stream input and parses it into an Open API document.
2221
/// </summary>
22+
/// <param name="input">Stream containing OpenAPI description to parse.</param>
23+
/// <param name="diagnostic">Returns diagnostic object containing errors detected during parsing</param>
24+
/// <returns>Instance of newly created OpenApiDocument</returns>
2325
public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)
2426
{
2527
ParsingContext context;
28+
YamlDocument yamlDocument;
2629
diagnostic = new OpenApiDiagnostic();
2730

2831
try
2932
{
30-
YamlDocument yamlDocument = LoadYamlDocument(input);
31-
context = new ParsingContext();
32-
return context.Parse(yamlDocument, diagnostic);
33-
33+
yamlDocument = LoadYamlDocument(input);
3434
}
3535
catch (SyntaxErrorException ex)
3636
{
3737
diagnostic.Errors.Add(new OpenApiError(string.Empty, ex.Message));
38-
3938
return new OpenApiDocument();
4039
}
41-
40+
41+
context = new ParsingContext();
42+
return context.Parse(yamlDocument, diagnostic);
4243
}
4344

4445
/// <summary>
4546
/// Helper method to turn streams into YamlDocument
4647
/// </summary>
47-
/// <param name="input"></param>
48-
/// <returns></returns>
48+
/// <param name="input">Stream containing YAML formatted text</param>
49+
/// <returns>Instance of a YamlDocument</returns>
4950
internal static YamlDocument LoadYamlDocument(Stream input)
5051
{
5152
YamlDocument yamlDocument;

‎src/Microsoft.OpenApi.Readers/ParsingContext.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,6 @@ private void ComputeTags(List<OpenApiTag> tags, Func<MapNode,OpenApiTag> loadTag
9292
}
9393
}
9494

95-
96-
97-
9895
/// <summary>
9996
/// Service providing all Version specific conversion functions
10097
/// </summary>

‎src/Microsoft.OpenApi.Readers/V2/OpenApiV2VersionService.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@ namespace Microsoft.OpenApi.Readers.V2
1717
/// </summary>
1818
internal class OpenApiV2VersionService : IOpenApiVersionService
1919
{
20-
public Func<MapNode, OpenApiTag> TagLoader { get { return OpenApiV2Deserializer.LoadTag; } }
21-
20+
/// <summary>
21+
/// Return a function that converts a MapNode into a V2 OpenApiTag
22+
/// </summary>
23+
public Func<MapNode, OpenApiTag> TagLoader => OpenApiV2Deserializer.LoadTag;
2224

2325
/// <summary>
2426
/// Load the referenced <see cref="IOpenApiReferenceable"/> object from a <see cref="OpenApiReference"/> object

‎src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ namespace Microsoft.OpenApi.Readers.V3
1818
/// </summary>
1919
internal class OpenApiV3VersionService : IOpenApiVersionService
2020
{
21+
/// <summary>
22+
/// Return a function that converts a MapNode into a V3 OpenApiTag
23+
/// </summary>
2124
public Func<MapNode, OpenApiTag> TagLoader => OpenApiV3Deserializer.LoadTag;
2225

2326
/// <summary>

‎test/Microsoft.OpenApi.Readers.Tests/ReferenceService/ConvertToOpenApiReferenceV2Tests.cs

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,22 @@
66
using Microsoft.OpenApi.Readers.V2;
77
using Xunit;
88

9-
namespace Microsoft.OpenApi.Readers.Tests.ReferenceService
9+
namespace Microsoft.OpenApi.Readers.Tests
1010
{
1111
public class ConvertToOpenApiReferenceV2Tests
1212
{
13-
1413

1514
[Fact]
1615
public void ParseExternalReference()
1716
{
1817
// Arrange
19-
var referenceService = new OpenApiV2VersionService();
18+
var versionService = new OpenApiV2VersionService();
2019
var externalResource = "externalSchema.json";
2120
var id = "externalPathSegment1/externalPathSegment2/externalPathSegment3";
2221
var input = $"{externalResource}#/{id}";
2322

2423
// Act
25-
var reference = referenceService.ConvertToOpenApiReference(input, null);
24+
var reference = versionService.ConvertToOpenApiReference(input, null);
2625

2726
// Assert
2827
reference.ExternalResource.Should().Be(externalResource);
@@ -34,13 +33,13 @@ public void ParseExternalReference()
3433
public void ParseLocalParameterReference()
3534
{
3635
// Arrange
37-
var referenceService = new OpenApiV2VersionService();
36+
var versionService = new OpenApiV2VersionService();
3837
var referenceType = ReferenceType.Parameter;
3938
var id = "parameterId";
4039
var input = $"#/parameters/{id}";
4140

4241
// Act
43-
var reference = referenceService.ConvertToOpenApiReference(input, referenceType);
42+
var reference = versionService.ConvertToOpenApiReference(input, referenceType);
4443

4544
// Assert
4645
reference.Type.Should().Be(referenceType);
@@ -52,13 +51,13 @@ public void ParseLocalParameterReference()
5251
public void ParseLocalSchemaReference()
5352
{
5453
// Arrange
55-
var referenceService = new OpenApiV2VersionService();
54+
var versionService = new OpenApiV2VersionService();
5655
var referenceType = ReferenceType.Schema;
5756
var id = "parameterId";
5857
var input = $"#/definitions/{id}";
5958

6059
// Act
61-
var reference = referenceService.ConvertToOpenApiReference(input, referenceType);
60+
var reference = versionService.ConvertToOpenApiReference(input, referenceType);
6261

6362
// Assert
6463
reference.Type.Should().Be(referenceType);
@@ -70,13 +69,13 @@ public void ParseLocalSchemaReference()
7069
public void ParseTagReference()
7170
{
7271
// Arrange
73-
var referenceService = new OpenApiV2VersionService();
72+
var versionService = new OpenApiV2VersionService();
7473
var referenceType = ReferenceType.Tag;
7574
var id = "tagId";
7675
var input = $"{id}";
7776

7877
// Act
79-
var reference = referenceService.ConvertToOpenApiReference(input, referenceType);
78+
var reference = versionService.ConvertToOpenApiReference(input, referenceType);
8079

8180
// Assert
8281
reference.Type.Should().Be(referenceType);
@@ -88,13 +87,13 @@ public void ParseTagReference()
8887
public void ParseSecuritySchemeReference()
8988
{
9089
// Arrange
91-
var referenceService = new OpenApiV2VersionService();
90+
var versionService = new OpenApiV2VersionService();
9291
var referenceType = ReferenceType.SecurityScheme;
9392
var id = "securitySchemeId";
9493
var input = $"{id}";
9594

9695
// Act
97-
var reference = referenceService.ConvertToOpenApiReference(input, referenceType);
96+
var reference = versionService.ConvertToOpenApiReference(input, referenceType);
9897

9998
// Assert
10099
reference.Type.Should().Be(referenceType);

‎test/Microsoft.OpenApi.Readers.Tests/ReferenceService/ConvertToOpenApiReferenceV3Tests.cs

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,22 @@
66
using Microsoft.OpenApi.Readers.V3;
77
using Xunit;
88

9-
namespace Microsoft.OpenApi.Readers.Tests.ReferenceService
9+
namespace Microsoft.OpenApi.Readers.Tests
1010
{
1111
public class ConvertToOpenApiReferenceV3Tests
1212
{
13-
1413

1514
[Fact]
1615
public void ParseExternalReference()
1716
{
1817
// Arrange
19-
var referenceService = new OpenApiV3VersionService();
18+
var versionService = new OpenApiV3VersionService();
2019
var externalResource = "externalSchema.json";
2120
var id = "externalPathSegment1/externalPathSegment2/externalPathSegment3";
2221
var input = $"{externalResource}#/{id}";
2322

2423
// Act
25-
var reference = referenceService.ConvertToOpenApiReference(input, null);
24+
var reference = versionService.ConvertToOpenApiReference(input, null);
2625

2726
// Assert
2827
reference.Type.Should().BeNull();
@@ -34,13 +33,13 @@ public void ParseExternalReference()
3433
public void ParseLocalParameterReference()
3534
{
3635
// Arrange
37-
var referenceService = new OpenApiV3VersionService();
36+
var versionService = new OpenApiV3VersionService();
3837
var referenceType = ReferenceType.Parameter;
3938
var id = "parameterId";
4039
var input = $"#/components/parameters/{id}";
4140

4241
// Act
43-
var reference = referenceService.ConvertToOpenApiReference(input, referenceType);
42+
var reference = versionService.ConvertToOpenApiReference(input, referenceType);
4443

4544
// Assert
4645
reference.Type.Should().Be(referenceType);
@@ -52,13 +51,13 @@ public void ParseLocalParameterReference()
5251
public void ParseLocalSchemaReference()
5352
{
5453
// Arrange
55-
var referenceService = new OpenApiV3VersionService();
54+
var versionService = new OpenApiV3VersionService();
5655
var referenceType = ReferenceType.Schema;
5756
var id = "schemaId";
5857
var input = $"#/components/schemas/{id}";
5958

6059
// Act
61-
var reference = referenceService.ConvertToOpenApiReference(input, referenceType);
60+
var reference = versionService.ConvertToOpenApiReference(input, referenceType);
6261

6362
// Assert
6463
reference.Type.Should().Be(referenceType);
@@ -70,13 +69,13 @@ public void ParseLocalSchemaReference()
7069
public void ParseTagReference()
7170
{
7271
// Arrange
73-
var referenceService = new OpenApiV3VersionService();
72+
var versionService = new OpenApiV3VersionService();
7473
var referenceType = ReferenceType.Tag;
7574
var id = "tagId";
7675
var input = $"{id}";
7776

7877
// Act
79-
var reference = referenceService.ConvertToOpenApiReference(input, referenceType);
78+
var reference = versionService.ConvertToOpenApiReference(input, referenceType);
8079

8180
// Assert
8281
reference.Type.Should().Be(referenceType);
@@ -88,13 +87,13 @@ public void ParseTagReference()
8887
public void ParseSecuritySchemeReference()
8988
{
9089
// Arrange
91-
var referenceService = new OpenApiV3VersionService();
90+
var versionService = new OpenApiV3VersionService();
9291
var referenceType = ReferenceType.SecurityScheme;
9392
var id = "securitySchemeId";
9493
var input = $"{id}";
9594

9695
// Act
97-
var reference = referenceService.ConvertToOpenApiReference(input, referenceType);
96+
var reference = versionService.ConvertToOpenApiReference(input, referenceType);
9897

9998
// Assert
10099
reference.Type.Should().Be(referenceType);

0 commit comments

Comments
 (0)