Skip to content

Commit 7964975

Browse files
committed
Fixed issues based on PR reviews
1 parent 0a63352 commit 7964975

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
The **OpenAPI.NET** SDK contains a useful object model for OpenAPI documents in .NET along with common serializers to extract raw OpenAPI JSON and YAML documents from the model.
77

8-
**See more information on the OpenAPI spec and its history here: <a href="https://www.openapis.org">OpenAPI Initiative</a>**
8+
**See more information on the OpenAPI spec and its history here: <a href="https://www.openapis.org">Open API Initiative</a>**
99

1010
Project Objectives
1111

@@ -20,13 +20,13 @@ The OpenAPI.NET project holds the base object model for representing OpenAPI des
2020
The base JSON and YAML Readers are built into this project. Below is the list of supported "reader" projects.
2121

2222
- .NET Comment Reader: [Coming Soon]
23-
- OData (CSDL) Reader: [Comming Soon]
23+
- OData (CSDL) Reader: [Coming Soon]
2424

2525
# Example Usage
2626

27-
Creating a OpenAPI Document
27+
Creating an OpenAPI Document
2828

29-
```Csharp
29+
```C#
3030
var document = new OpenApiDocument
3131
{
3232
Info = new OpenApiInfo
@@ -63,7 +63,7 @@ var document = new OpenApiDocument
6363

6464
Reading and writing a OpenAPI description
6565

66-
``` CSharp
66+
```C#
6767
var httpClient = new HttpClient
6868
{
6969
BaseAddress = new Uri("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/")
@@ -72,7 +72,7 @@ var httpClient = new HttpClient
7272
var stream = await httpClient.GetStreamAsync("master/examples/v3.0/petstore.yaml");
7373

7474
// Read V3 as YAML
75-
var openApiDocument = new OpenApiStreamReader().Read(stream, out var diagnostics);
75+
var openApiDocument = new OpenApiStreamReader().Read(stream, out var diagnostic);
7676

7777
var outputStringWriter = new StringWriter();
7878
var writer = new OpenApiJsonWriter(outputStringWriter);
@@ -83,10 +83,6 @@ openApiDocument.SerializeAsV2(writer);
8383
outputStringWriter.Flush();
8484
var output = outputStringWriter.GetStringBuilder().ToString();
8585

86-
Assert.Empty(diagnostics.Errors);
87-
Assert.NotNull(openApiDocument);
88-
Assert.NotEmpty(output);
89-
9086
```
9187

9288
# Build Status
@@ -109,4 +105,4 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
109105
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
110106
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
111107

112-
To provide feedback and ask questions you can use StackOverflow in the [OpenApi.net](https://stackoverflow.com/questions/tagged/openapi.net) tag or use the Slack OpenApi.net Slack channel which you can register for at http://slack.httpapis.com
108+
To provide feedback and ask questions you can use StackOverflow with the [OpenApi.net](https://stackoverflow.com/questions/tagged/openapi.net) tag or use the OpenApi.net Slack channel which you can register for at http://slack.httpapis.com

0 commit comments

Comments
 (0)