Skip to content

Commit fda05d4

Browse files
baywetbaywet
committed
fix: makes reference fields immutable
1 parent f3a601b commit fda05d4

File tree

6 files changed

+57
-31
lines changed

6 files changed

+57
-31
lines changed

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

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,28 @@
44
using System;
55
using Microsoft.OpenApi.Extensions;
66
using Microsoft.OpenApi.Interfaces;
7+
using Microsoft.OpenApi.Models.Interfaces;
78
using Microsoft.OpenApi.Writers;
89

10+
#if !NET5_0_OR_GREATER
11+
namespace System.Runtime.CompilerServices {
12+
using System.ComponentModel;
13+
/// <summary>
14+
/// Reserved to be used by the compiler for tracking metadata.
15+
/// This class should not be used by developers in source code.
16+
/// </summary>
17+
[EditorBrowsable(EditorBrowsableState.Never)]
18+
internal static class IsExternalInit {
19+
}
20+
}
21+
#endif
22+
923
namespace Microsoft.OpenApi.Models
1024
{
1125
/// <summary>
1226
/// A simple object to allow referencing other components in the specification, internally and externally.
1327
/// </summary>
14-
public class OpenApiReference : IOpenApiSerializable
28+
public class OpenApiReference : IOpenApiSerializable, IOpenApiDescribedElement, IOpenApiSummarizedElement
1529
{
1630
/// <summary>
1731
/// A short summary which by default SHOULD override that of the referenced component.
@@ -32,13 +46,13 @@ public class OpenApiReference : IOpenApiSerializable
3246
/// 1. a absolute/relative file path, for example: ../commons/pet.json
3347
/// 2. a Url, for example: http://localhost/pet.json
3448
/// </summary>
35-
public string ExternalResource { get; set; }
49+
public string ExternalResource { get; init; }
3650

3751
/// <summary>
3852
/// The element type referenced.
3953
/// </summary>
4054
/// <remarks>This must be present if <see cref="ExternalResource"/> is not present.</remarks>
41-
public ReferenceType? Type { get; set; }
55+
public ReferenceType? Type { get; init; }
4256

4357
/// <summary>
4458
/// The identifier of the reusable component of one particular ReferenceType.
@@ -47,7 +61,7 @@ public class OpenApiReference : IOpenApiSerializable
4761
/// If ExternalResource is not present, this is the name of the component without the reference type name.
4862
/// For example, if the reference is '#/components/schemas/componentName', the Id is 'componentName'.
4963
/// </summary>
50-
public string Id { get; set; }
64+
public string Id { get; init; }
5165

5266
/// <summary>
5367
/// Gets a flag indicating whether this reference is an external reference.
@@ -62,12 +76,12 @@ public class OpenApiReference : IOpenApiSerializable
6276
/// <summary>
6377
/// Gets a flag indicating whether a file is a valid OpenAPI document or a fragment
6478
/// </summary>
65-
public bool IsFragment = false;
79+
public bool IsFragment { get; init; }
6680

6781
/// <summary>
6882
/// The OpenApiDocument that is hosting the OpenApiReference instance. This is used to enable dereferencing the reference.
6983
/// </summary>
70-
public OpenApiDocument HostDocument { get; set; }
84+
public OpenApiDocument HostDocument { get; init; }
7185

7286
/// <summary>
7387
/// Gets the full reference string for v3.0.
@@ -145,12 +159,13 @@ public OpenApiReference() { }
145159
/// </summary>
146160
public OpenApiReference(OpenApiReference reference)
147161
{
148-
Summary = reference?.Summary;
149-
Description = reference?.Description;
150-
ExternalResource = reference?.ExternalResource;
151-
Type = reference?.Type;
152-
Id = reference?.Id;
153-
HostDocument = reference?.HostDocument;
162+
Utils.CheckArgumentNull(reference);
163+
Summary = reference.Summary;
164+
Description = reference.Description;
165+
ExternalResource = reference.ExternalResource;
166+
Type = reference.Type;
167+
Id = reference.Id;
168+
HostDocument = reference.HostDocument;
154169
}
155170

156171
/// <summary>

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

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ public OpenApiReference ConvertToOpenApiReference(
116116
}
117117
// Where fragments point into a non-OpenAPI document, the id will be the complete fragment identifier
118118
var id = segments[1];
119-
var openApiReference = new OpenApiReference();
119+
var isFragment = false;
120120

121121
// $ref: externalSource.yaml#/Pet
122122
if (id.StartsWith("/components/", StringComparison.Ordinal))
@@ -152,12 +152,16 @@ public OpenApiReference ConvertToOpenApiReference(
152152
}
153153
else
154154
{
155-
openApiReference.IsFragment = true;
155+
isFragment = true;
156156
}
157157

158-
openApiReference.ExternalResource = segments[0];
159-
openApiReference.Type = type;
160-
openApiReference.Id = id;
158+
var openApiReference = new OpenApiReference
159+
{
160+
ExternalResource = segments[0],
161+
Type = type,
162+
Id = id,
163+
IsFragment = isFragment,
164+
};
161165

162166
return openApiReference;
163167
}

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@ public override void Visit(IOpenApiReferenceHolder referenceHolder)
2323
{
2424
if (referenceHolder.Reference != null)
2525
{
26-
referenceHolder.Reference.HostDocument = _currentDocument;
26+
referenceHolder.Reference = new OpenApiReference(referenceHolder.Reference)
27+
{
28+
HostDocument = _currentDocument,
29+
};
2730
}
2831
}
2932
}

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,11 @@ public async Task LoadResponseAndSchemaReference()
118118
}
119119
};
120120

121-
((OpenApiSchemaReference)expected.Content["application/json"].Schema).Reference.HostDocument = result.Document;
121+
var schemaReference = (OpenApiSchemaReference)expected.Content["application/json"].Schema;
122+
schemaReference.Reference = new OpenApiReference(schemaReference.Reference)
123+
{
124+
HostDocument = result.Document,
125+
};
122126
var actual = reference.Target;
123127

124128
// Assert

‎test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDocumentTests.cs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1046,11 +1046,11 @@ public async Task ParseModifiedPetStoreDocumentWithTagAndSecurityShouldSucceed()
10461046
}
10471047
};
10481048

1049-
tagReference1.Reference.HostDocument = expected;
1050-
tagReference2.Reference.HostDocument = expected;
1051-
petSchemaReference.Reference.HostDocument = expected;
1052-
newPetSchemaReference.Reference.HostDocument = expected;
1053-
errorModelSchemaReference.Reference.HostDocument = expected;
1049+
tagReference1.Reference = new OpenApiReference(tagReference1.Reference) {HostDocument = expected };
1050+
tagReference2.Reference = new OpenApiReference(tagReference2.Reference) {HostDocument = expected };
1051+
petSchemaReference.Reference = new OpenApiReference(petSchemaReference.Reference) {HostDocument = expected };
1052+
newPetSchemaReference.Reference = new OpenApiReference(newPetSchemaReference.Reference) {HostDocument = expected };
1053+
errorModelSchemaReference.Reference = new OpenApiReference(errorModelSchemaReference.Reference) {HostDocument = expected };
10541054

10551055
actual.Document.Should().BeEquivalentTo(expected, options => options
10561056
.IgnoringCyclicReferences()
@@ -1284,7 +1284,7 @@ public async Task ParseDocWithRefsUsingProxyReferencesSucceeds()
12841284
var outputDoc = (await doc.SerializeAsYamlAsync(OpenApiSpecVersion.OpenApi3_0)).MakeLineBreaksEnvironmentNeutral();
12851285
var expectedParam = expected.Paths["/pets"].Operations[OperationType.Get].Parameters[0];
12861286
var expectedParamReference = Assert.IsType<OpenApiParameterReference>(expectedParam);
1287-
expectedParamReference.Reference.HostDocument = doc;
1287+
expectedParamReference.Reference = new OpenApiReference(expectedParamReference.Reference) {HostDocument = doc};
12881288

12891289
var actualParamReference = Assert.IsType<OpenApiParameterReference>(actualParam);
12901290

‎test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -957,21 +957,21 @@ namespace Microsoft.OpenApi.Models
957957
public OpenApiPaths() { }
958958
public OpenApiPaths(Microsoft.OpenApi.Models.OpenApiPaths paths) { }
959959
}
960-
public class OpenApiReference : Microsoft.OpenApi.Interfaces.IOpenApiElement, Microsoft.OpenApi.Interfaces.IOpenApiSerializable
960+
public class OpenApiReference : Microsoft.OpenApi.Interfaces.IOpenApiElement, Microsoft.OpenApi.Interfaces.IOpenApiSerializable, Microsoft.OpenApi.Models.Interfaces.IOpenApiDescribedElement, Microsoft.OpenApi.Models.Interfaces.IOpenApiSummarizedElement
961961
{
962-
public bool IsFragment;
963962
public OpenApiReference() { }
964963
public OpenApiReference(Microsoft.OpenApi.Models.OpenApiReference reference) { }
965964
public string Description { get; set; }
966-
public string ExternalResource { get; set; }
967-
public Microsoft.OpenApi.Models.OpenApiDocument HostDocument { get; set; }
968-
public string Id { get; set; }
969965
public bool IsExternal { get; }
970966
public bool IsLocal { get; }
971967
public string ReferenceV2 { get; }
972968
public string ReferenceV3 { get; }
973969
public string Summary { get; set; }
974-
public Microsoft.OpenApi.Models.ReferenceType? Type { get; set; }
970+
public string ExternalResource { get; init; }
971+
public Microsoft.OpenApi.Models.OpenApiDocument HostDocument { get; init; }
972+
public string Id { get; init; }
973+
public bool IsFragment { get; init; }
974+
public Microsoft.OpenApi.Models.ReferenceType? Type { get; init; }
975975
public void SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter writer) { }
976976
public void SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter writer) { }
977977
public void SerializeAsV31(Microsoft.OpenApi.Writers.IOpenApiWriter writer) { }

0 commit comments

Comments
 (0)