Skip to content

Commit 169c94c

Browse files
darrelmillerdarrelmiller
committed
Cleanup
1 parent 9d0249e commit 169c94c

File tree

10 files changed

+44
-51
lines changed

10 files changed

+44
-51
lines changed

‎src/Microsoft.OpenApi.Readers/ReferenceServices/IOpenApiVersionService.cs renamed to ‎src/Microsoft.OpenApi.Readers/Interface/IOpenApiVersionService.cs

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
using Microsoft.OpenApi.Readers.ParseNodes;
77
using System;
88

9-
namespace Microsoft.OpenApi.Readers.ReferenceServices
9+
namespace Microsoft.OpenApi.Readers.Interface
1010
{
1111
/// <summary>
1212
/// Interface to a version specific parsing implementations.
@@ -16,7 +16,7 @@ internal interface IOpenApiVersionService
1616
/// <summary>
1717
/// Load the referenced <see cref="IOpenApiReferenceable"/> object from a <see cref="OpenApiReference"/> object
1818
/// </summary>
19-
/// <param name="context"></param>
19+
/// <param name="context">Instance of ParsingContext to use for retrieving references.</param>
2020
/// <param name="reference">The <see cref="OpenApiReference"/> object.</param>
2121
/// <param name="referencedObject">The object that is being referenced.</param>
2222
/// <returns>
@@ -35,12 +35,16 @@ internal interface IOpenApiVersionService
3535
/// <returns>The <see cref="OpenApiReference"/> object or null.</returns>
3636
OpenApiReference ConvertToOpenApiReference(string reference, ReferenceType? type);
3737

38-
3938
/// <summary>
40-
/// Function that converts MapNodes into Tag objects in a version specific way
39+
/// Function that converts a MapNode into a Tag object in a version specific way
4140
/// </summary>
4241
Func<MapNode, OpenApiTag> TagLoader { get; }
4342

44-
OpenApiDocument LoadOpenApi(RootNode rootNode);
43+
/// <summary>
44+
/// Converts a generic RootNode instance into a strongly typed OpenApiDocument
45+
/// </summary>
46+
/// <param name="rootNode"></param>
47+
/// <returns>Instance of OpenApiDocument populated with data from rootNode</returns>
48+
OpenApiDocument LoadDocument(RootNode rootNode);
4549
}
4650
}

‎src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,6 @@
2525
<AssemblyOriginatorKeyFile>..\Microsoft.OpenApi.snk</AssemblyOriginatorKeyFile>
2626
</PropertyGroup>
2727

28-
<ItemGroup>
29-
<Compile Remove="ReferenceServices\OpenApiReferenceServiceBase.cs" />
30-
</ItemGroup>
31-
3228
<ItemGroup>
3329
<PackageReference Include="SharpYaml" Version="1.6.1" />
3430
</ItemGroup>

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@
55
using System.Linq;
66
using Microsoft.OpenApi.Models;
77
using Microsoft.OpenApi.Readers.Interface;
8-
using Microsoft.OpenApi.Readers.ParseNodes;
9-
using Microsoft.OpenApi.Readers.ReferenceServices;
10-
using Microsoft.OpenApi.Readers.V2;
11-
using Microsoft.OpenApi.Readers.V3;
128
using SharpYaml;
139
using SharpYaml.Serialization;
1410

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

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66
using System.Linq;
77
using Microsoft.OpenApi.Interfaces;
88
using Microsoft.OpenApi.Models;
9+
using Microsoft.OpenApi.Readers.Interface;
910
using Microsoft.OpenApi.Readers.ParseNodes;
10-
using Microsoft.OpenApi.Readers.ReferenceServices;
11+
using Microsoft.OpenApi.Readers.V2;
12+
using Microsoft.OpenApi.Readers.V3;
1113
using SharpYaml.Serialization;
1214

1315
namespace Microsoft.OpenApi.Readers
@@ -41,20 +43,20 @@ internal OpenApiDocument Parse(YamlDocument yamlDocument, OpenApiDiagnostic diag
4143

4244
if ( inputVersion == "2.0")
4345
{
44-
ReferenceService = new OpenApiV2VersionService();
45-
doc = this.ReferenceService.LoadOpenApi(this.RootNode);
46+
VersionService = new OpenApiV2VersionService();
47+
doc = this.VersionService.LoadDocument(this.RootNode);
4648
}
4749
else if (inputVersion.StartsWith("3.0."))
4850
{
49-
this.ReferenceService = new OpenApiV3VersionService();
50-
doc = this.ReferenceService.LoadOpenApi(this.RootNode);
51+
this.VersionService = new OpenApiV3VersionService();
52+
doc = this.VersionService.LoadDocument(this.RootNode);
5153
}
5254
else
5355
{
5456
// If version number is not recognizable,
5557
// our best effort will try to deserialize the document to V3.
56-
this.ReferenceService = new OpenApiV3VersionService();
57-
doc = this.ReferenceService.LoadOpenApi(this.RootNode);
58+
this.VersionService = new OpenApiV3VersionService();
59+
doc = this.VersionService.LoadDocument(this.RootNode);
5860
}
5961
return doc;
6062
}
@@ -94,9 +96,9 @@ private void ComputeTags(List<OpenApiTag> tags, Func<MapNode,OpenApiTag> loadTag
9496

9597

9698
/// <summary>
97-
/// Reference service.
99+
/// Service providing all Version specific conversion functions
98100
/// </summary>
99-
internal IOpenApiVersionService ReferenceService
101+
internal IOpenApiVersionService VersionService
100102
{
101103
get
102104
{
@@ -105,7 +107,7 @@ internal IOpenApiVersionService ReferenceService
105107
set
106108
{
107109
_versionService = value;
108-
ComputeTags(Tags, ReferenceService.TagLoader);
110+
ComputeTags(Tags, VersionService.TagLoader);
109111
}
110112
}
111113

@@ -141,9 +143,9 @@ public IOpenApiReferenceable GetReferencedObject(
141143
return referencedObject;
142144
}
143145

144-
var reference = ReferenceService.ConvertToOpenApiReference(referenceString, referenceType);
146+
var reference = VersionService.ConvertToOpenApiReference(referenceString, referenceType);
145147

146-
var isReferencedObjectFound = ReferenceService.TryLoadReference(this, reference, out referencedObject);
148+
var isReferencedObjectFound = VersionService.TryLoadReference(this, reference, out referencedObject);
147149

148150
if (isReferencedObjectFound)
149151
{

‎src/Microsoft.OpenApi.Readers/ReferenceServices/OpenApiV2VersionService.cs renamed to ‎src/Microsoft.OpenApi.Readers/V2/OpenApiV2VersionService.cs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,15 @@
22
// Licensed under the MIT license.
33

44
using System;
5-
using System.Collections.Generic;
65
using Microsoft.OpenApi.Exceptions;
76
using Microsoft.OpenApi.Interfaces;
87
using Microsoft.OpenApi.Models;
8+
using Microsoft.OpenApi.Readers.Interface;
99
using Microsoft.OpenApi.Readers.ParseNodes;
1010
using Microsoft.OpenApi.Readers.Properties;
11-
using Microsoft.OpenApi.Readers.V2;
1211

1312

14-
namespace Microsoft.OpenApi.Readers.ReferenceServices
13+
namespace Microsoft.OpenApi.Readers.V2
1514
{
1615
/// <summary>
1716
/// The version specific implementations for OpenAPI V2.0.
@@ -224,7 +223,7 @@ public OpenApiReference ConvertToOpenApiReference(string reference, ReferenceTyp
224223
throw new OpenApiException(string.Format(SRResource.ReferenceHasInvalidFormat, reference));
225224
}
226225

227-
public OpenApiDocument LoadOpenApi(RootNode rootNode)
226+
public OpenApiDocument LoadDocument(RootNode rootNode)
228227
{
229228
return OpenApiV2Deserializer.LoadOpenApi(rootNode);
230229
}

‎src/Microsoft.OpenApi.Readers/ReferenceServices/OpenApiV3VersionService.cs renamed to ‎src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
using Microsoft.OpenApi.Extensions;
88
using Microsoft.OpenApi.Interfaces;
99
using Microsoft.OpenApi.Models;
10+
using Microsoft.OpenApi.Readers.Interface;
1011
using Microsoft.OpenApi.Readers.ParseNodes;
1112
using Microsoft.OpenApi.Readers.Properties;
12-
using Microsoft.OpenApi.Readers.V3;
1313

14-
namespace Microsoft.OpenApi.Readers.ReferenceServices
14+
namespace Microsoft.OpenApi.Readers.V3
1515
{
1616
/// <summary>
17-
/// The reference service for the Open API V3.0.
17+
/// The version service for the Open API V3.0.
1818
/// </summary>
1919
internal class OpenApiV3VersionService : IOpenApiVersionService
2020
{
@@ -72,7 +72,7 @@ public OpenApiReference ConvertToOpenApiReference(
7272
throw new OpenApiException(string.Format(SRResource.ReferenceHasInvalidFormat, reference));
7373
}
7474

75-
public OpenApiDocument LoadOpenApi(RootNode rootNode)
75+
public OpenApiDocument LoadDocument(RootNode rootNode)
7676
{
7777
return OpenApiV3Deserializer.LoadOpenApi(rootNode);
7878
}

‎src/Microsoft.OpenApi/Services/OpenApiWalker.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
// Copyright (c) Microsoft Corporation. All rights reserved.
22
// Licensed under the MIT license.
33

4-
using System.Collections.Generic;
54
using Microsoft.OpenApi.Models;
5+
using System.Collections.Generic;
66

77
namespace Microsoft.OpenApi.Services
88
{

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33

44
using FluentAssertions;
55
using Microsoft.OpenApi.Models;
6-
using Microsoft.OpenApi.Readers.ParseNodes;
7-
using Microsoft.OpenApi.Readers.ReferenceServices;
8-
using SharpYaml.Serialization;
6+
using Microsoft.OpenApi.Readers.V2;
97
using Xunit;
108

119
namespace Microsoft.OpenApi.Readers.Tests.ReferenceService

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33

44
using FluentAssertions;
55
using Microsoft.OpenApi.Models;
6-
using Microsoft.OpenApi.Readers.ParseNodes;
7-
using Microsoft.OpenApi.Readers.ReferenceServices;
8-
using SharpYaml.Serialization;
6+
using Microsoft.OpenApi.Readers.V3;
97
using Xunit;
108

119
namespace Microsoft.OpenApi.Readers.Tests.ReferenceService

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
using FluentAssertions;
77
using Microsoft.OpenApi.Models;
88
using Microsoft.OpenApi.Readers.ParseNodes;
9-
using Microsoft.OpenApi.Readers.ReferenceServices;
9+
using Microsoft.OpenApi.Readers.V2;
1010
using SharpYaml.Serialization;
1111
using Xunit;
1212

@@ -33,7 +33,7 @@ public void LoadSchemaReference()
3333
context.RootNode = new RootNode(context, diagnostic, yamlDocument);
3434
}
3535

36-
context.ReferenceService = new OpenApiV2VersionService();
36+
context.VersionService = new OpenApiV2VersionService();
3737

3838
var reference = new OpenApiReference
3939
{
@@ -42,7 +42,7 @@ public void LoadSchemaReference()
4242
};
4343

4444
// Act
45-
context.ReferenceService.TryLoadReference(context, reference, out var referencedObject);
45+
context.VersionService.TryLoadReference(context, reference, out var referencedObject);
4646

4747
// Assert
4848
referencedObject.ShouldBeEquivalentTo(
@@ -89,7 +89,7 @@ public void LoadParameterReference()
8989
context.RootNode = new RootNode(context, diagnostic, yamlDocument);
9090
}
9191

92-
context.ReferenceService = new OpenApiV2VersionService();
92+
context.VersionService = new OpenApiV2VersionService();
9393

9494
var reference = new OpenApiReference
9595
{
@@ -98,7 +98,7 @@ public void LoadParameterReference()
9898
};
9999

100100
// Act
101-
context.ReferenceService.TryLoadReference(context, reference, out var referencedObject);
101+
context.VersionService.TryLoadReference(context, reference, out var referencedObject);
102102

103103
// Assert
104104
referencedObject.ShouldBeEquivalentTo(
@@ -134,15 +134,15 @@ public void LoadSecuritySchemeReference()
134134
context.RootNode = new RootNode(context, diagnostic, yamlDocument);
135135
}
136136

137-
context.ReferenceService = new OpenApiV2VersionService();
137+
context.VersionService = new OpenApiV2VersionService();
138138
var reference = new OpenApiReference
139139
{
140140
Type = ReferenceType.SecurityScheme,
141141
Id = "api_key_sample"
142142
};
143143

144144
// Act
145-
context.ReferenceService.TryLoadReference(context, reference, out var referencedObject);
145+
context.VersionService.TryLoadReference(context, reference, out var referencedObject);
146146

147147
// Assert
148148
referencedObject.ShouldBeEquivalentTo(
@@ -171,7 +171,7 @@ public void LoadResponseReference()
171171
context.RootNode = new RootNode(context, diagnostic, yamlDocument);
172172
}
173173

174-
context.ReferenceService = new OpenApiV2VersionService();
174+
context.VersionService = new OpenApiV2VersionService();
175175

176176
var reference = new OpenApiReference
177177
{
@@ -180,7 +180,7 @@ public void LoadResponseReference()
180180
};
181181

182182
// Act
183-
context.ReferenceService.TryLoadReference(context,reference, out var referencedObject);
183+
context.VersionService.TryLoadReference(context,reference, out var referencedObject);
184184

185185
// Assert
186186
referencedObject.ShouldBeEquivalentTo(
@@ -207,7 +207,7 @@ public void LoadResponseAndSchemaReference()
207207
context.RootNode = new RootNode(context, diagnostic, yamlDocument);
208208
}
209209

210-
context.ReferenceService = new OpenApiV2VersionService();
210+
context.VersionService = new OpenApiV2VersionService();
211211

212212
var reference = new OpenApiReference
213213
{
@@ -216,7 +216,7 @@ public void LoadResponseAndSchemaReference()
216216
};
217217

218218
// Act
219-
context.ReferenceService.TryLoadReference(context, reference, out var referencedObject);
219+
context.VersionService.TryLoadReference(context, reference, out var referencedObject);
220220

221221
// Assert
222222
referencedObject.ShouldBeEquivalentTo(

0 commit comments

Comments
 (0)