Skip to content

Commit cb2a248

Browse files
committed
updates to build.cmd and readme
1 parent b0c4b92 commit cb2a248

File tree

2 files changed

+25
-7
lines changed

2 files changed

+25
-7
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,24 @@
33
# OpenAPI.NET [Preview]
44
[ Disclaimer: This repository is in a preview state. Expect to see some iterating as we work towards the final release candidate slated for early 2018. Feedback is welcome! ]
55

6-
The **OpenAPI.NET** SDK contains a useful object model for OpenAPI documents in .NET along with common serializers to extract raw OAI JSON and YAML documents from the model.
6+
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

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

1010
Project Objectives
1111

12-
- Provide a single shared object model in .NET for Open API documents.
13-
- Include the most primitive Reader for ingesting OAI JSON and YAML documents.
14-
- Enable developers to create Readers that translate different data formats into Open API documents.
12+
- Provide a single shared object model in .NET for OpenAPI descriptions.
13+
- Include the most primitive Reader for ingesting OAI JSON and YAML documents in both V2 and V3 formats.
14+
- Provide OpenAPI description writers for both V2 and V3 specification formats.
15+
- Enable developers to create Readers that translate different data formats into OpenAPI descriptions.
1516

1617
# Readers
17-
The OpenAPI.NET project holds the base object model for representing OAI documents 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.
18+
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.
1819

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

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

2325
# Build Status
2426

@@ -39,3 +41,5 @@ provided by the bot. You will only need to do this once across all repos using o
3941
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
4042
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
4143
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
44+
45+
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

build.cmd

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,24 @@
1-
SET VERSION=0.9.1
1+
@echo off
2+
if "%~1"=="" goto :error
3+
4+
SET %VERSION%=%~1
5+
6+
Echo Building Microsoft.OpenApi
7+
28
SET PROJ=%~dp0src\Microsoft.OpenApi\Microsoft.OpenApi.csproj
39
msbuild %PROJ% /t:restore /p:Configuration=Release
410
msbuild %PROJ% /t:build /p:Configuration=Release
511
msbuild %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts;Version=%VERSION%
612

13+
Echo Building Microsoft.OpenApi.Readers
14+
715
SET PROJ=%~dp0src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj
816
msbuild %PROJ% /t:restore /p:Configuration=Release
917
msbuild %PROJ% /t:build /p:Configuration=Release
10-
msbuild %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts;Version=%VERSION%
18+
msbuild %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts;Version=%VERSION%
19+
20+
goto :end
21+
:error
22+
echo Version parameter missing e.g. build.cmd 1.0.0-beta0008
23+
24+
:end

0 commit comments

Comments
 (0)