Skip to content

Commit 8bf012b

Browse files
committed
fix: example reference annotation parsing
Signed-off-by: Vincent Biret <[email protected]>
1 parent 86892b3 commit 8bf012b

File tree

2 files changed

+44
-1
lines changed

2 files changed

+44
-1
lines changed

src/Microsoft.OpenApi/Reader/V31/OpenApiExampleDeserializer.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,9 @@ public static IOpenApiExample LoadExample(ParseNode node, OpenApiDocument hostDo
5151
if (pointer != null)
5252
{
5353
var reference = GetReferenceIdAndExternalResource(pointer);
54-
return new OpenApiExampleReference(reference.Item1, hostDocument, reference.Item2);
54+
var exampleReference = new OpenApiExampleReference(reference.Item1, hostDocument, reference.Item2);
55+
exampleReference.Reference.SetMetadataFromMapNode(mapNode);
56+
return exampleReference;
5557
}
5658

5759
var example = new OpenApiExample();
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
using System.Text.Json.Nodes;
2+
using Microsoft.OpenApi.Reader;
3+
using Microsoft.OpenApi.Reader.V31;
4+
using Xunit;
5+
6+
namespace Microsoft.OpenApi.Readers.Tests.V31Tests;
7+
8+
public class OpenApiExampleReferenceDeserializerTests
9+
{
10+
[Fact]
11+
public void ShouldDeserializeExampleReferenceAnnotations()
12+
{
13+
var json =
14+
"""
15+
{
16+
"$ref": "#/components/examples/MyExample",
17+
"description": "This is an example reference",
18+
"summary": "Example Summary reference"
19+
}
20+
""";
21+
22+
var hostDocument = new OpenApiDocument();
23+
hostDocument.AddComponent("MyExample", new OpenApiExample
24+
{
25+
Summary = "This is an example",
26+
Description = "This is an example description",
27+
});
28+
var jsonNode = JsonNode.Parse(json);
29+
var parseNode = ParseNode.Create(new ParsingContext(new()), jsonNode);
30+
31+
var result = OpenApiV31Deserializer.LoadExample(parseNode, hostDocument);
32+
33+
Assert.NotNull(result);
34+
var resultReference = Assert.IsType<OpenApiExampleReference>(result);
35+
36+
Assert.Equal("MyExample", resultReference.Reference.Id);
37+
Assert.Equal("This is an example reference", resultReference.Description);
38+
Assert.Equal("Example Summary reference", resultReference.Summary);
39+
Assert.NotNull(resultReference.Target);
40+
}
41+
}

0 commit comments

Comments
 (0)