Skip to content

Commit 917fae3

Browse files
committed
Update doc comments and doc initialization
1 parent 0c05c3f commit 917fae3

File tree

3 files changed

+4
-5
lines changed

3 files changed

+4
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ var httpClient = new HttpClient
8484
var stream = await httpClient.GetStreamAsync("master/examples/v3.0/petstore.yaml");
8585

8686
// Read V3 as YAML
87-
var openApiDocument = new OpenApiStreamReader().Read(stream, out var diagnostic);
87+
var openApiDocument = OpenApiDocument.LoadAsync(stream).OpenApiDocument;
8888

8989
// Write V2 as JSON
9090
var outputString = openApiDocument.Serialize(OpenApiSpecVersion.OpenApi2_0, OpenApiFormat.Json);

src/Microsoft.OpenApi/Reader/OpenApiReaderSettings.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
using System.Collections.Generic;
66
using System.IO;
77
using System.Text.Json.Nodes;
8-
using Microsoft.OpenApi.Any;
98
using Microsoft.OpenApi.Interfaces;
109
using Microsoft.OpenApi.MicrosoftExtensions;
1110
using Microsoft.OpenApi.Validations;
@@ -77,7 +76,7 @@ public class OpenApiReaderSettings
7776

7877
/// <summary>
7978
/// Whether to leave the <see cref="Stream"/> object open after reading
80-
/// from an OpenApiStreamReader object.
79+
/// from a StreamReader object.
8180
/// </summary>
8281
public bool LeaveStreamOpen { get; set; }
8382

test/Microsoft.OpenApi.Readers.Tests/OpenApiReaderTests/OpenApiStreamReaderTests.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111

1212
namespace Microsoft.OpenApi.Readers.Tests.OpenApiReaderTests
1313
{
14-
public class OpenApiStreamReaderTests
14+
public class OpenApiDocumentLoadTests
1515
{
1616
private const string SampleFolderPath = "V3Tests/Samples/OpenApiDocument/";
1717

18-
public OpenApiStreamReaderTests()
18+
public OpenApiDocumentLoadTests()
1919
{
2020
OpenApiReaderRegistry.RegisterReader("yaml", new OpenApiYamlReader());
2121
}

0 commit comments

Comments
 (0)