Skip to content

Commit

Permalink
Merge pull request #251 from Microsoft/adding-processor-link
Browse files Browse the repository at this point in the history
Linking back the new C# annotations processor.
  • Loading branch information
EricAtMSFT authored May 8, 2018
2 parents 4ab77f9 + 300a597 commit 220b43f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ Project Objectives
- Provide OpenAPI description writers for both V2 and V3 specification formats.
- Enable developers to create Readers that translate different data formats into OpenAPI descriptions.

# Readers
The OpenAPI.NET project holds the base object model for representing OpenAPI descriptions as .NET objects. Translation for different data types into this object model is handled by reading raw JSON/YAML or from individual "Readers", a number of which are in the works.
# Processors
The OpenAPI.NET project holds the base object model for representing OpenAPI documents as .NET objects. Some developers have found the need to write processors that convert other data formats into this OpenAPI.NET object model. We'd like to curate that list of processors in this section of the readme.

The base JSON and YAML Readers are built into this project. Below is the list of supported "reader" projects.
The base JSON and YAML processors are built into this project. Below is the list of the other supported processor projects.

- .NET Comment Reader: [Coming Soon]
- [**C# Comment / Annotation Processor**](https://github.com/Microsoft/OpenAPI.NET.CSharpAnnotations) : Converts standard .NET annotations ( /// comments ) emitted from your build (MSBuild.exe) into OpenAPI.NET document object.

# Example Usage

Expand Down

0 comments on commit 220b43f

Please sign in to comment.