aspnetcore/src/Tools/Microsoft.dotnet-openapi
Doug Bunting c4c6e25a06
Add missing doc files and cleanup nits (#22931)
* nit: Remove useless `$(HasReferenceAssembly)` settings
  - set in /Directory.Build.targets
    - `true` only in `$(IsAspNetCoreApp)` projects
* nit: Remove useless `$(CompileUsingReferenceAssemblies)` settings
  - no current versioning differences between ref/ and src/ assemblies when targeting default TFM
* Add more `$(GenerateDocumentationFile)` settings
  - increases the number of generated doc files, mostly without problems
- !fixup! correct typo in `DebugProxyHost` doc comments
    - was not generating a doc file before
  - remove previous (ineffective) src/Components/Directory.Build.targets setting
  - nit: remove a duplicate `$(GenerateDocumentationFile)` setting
* nit: Remove useless `$(IsPackable)` settings
  - only analyzers and implementation projects are packable by default
    - main use case for explicit setting is projects shipping only in shared framework
  - conditional setting in src/Mvc/Directory.Build.props just subset logic in /Directory.Build.targets
* nit: Remove useless `$(IsProjectReferenceProvider)` settings
  - only implementation projects are providers by default
* nit: Remove useless `$(IsTestAssetProject)` settings
  - set in src/Mvc/test/WebSites/Directory.Build.props
* !fixup! Looks like `InProcessNewShimWebSite` must compile w/o ref/ assemblies
  - restore `$(CompileUsingReferenceAssemblies)` in this one project
2020-06-17 13:04:45 -07:00
..
src Add missing doc files and cleanup nits (#22931) 2020-06-17 13:04:45 -07:00
test
README.md

README.md

Microsoft.dotnet-openapi

Microsoft.dotnet-openapi is a tool for managing OpenAPI references within your project.

Commands

Add Commands

Add File

Options
Short option Long option Description Example
-p --updateProject The project to operate on. dotnet openapi add file --updateProject .\Ref.csproj .\OpenAPI.json
Arguments
Argument Description Example
source-file The source to create a reference from. Must be an OpenAPI file. dotnet openapi add file .\OpenAPI.json

Add URL

Options
Short option Long option Description Example
-p --updateProject The project to operate on. dotnet openapi add url --updateProject .\Ref.csproj http://contoso.com/openapi.json
-o --output-file Where to place the local copy of the OpenAPI file. dotnet openapi add url https://contoso.com/openapi.json --output-file myclient.json
Arguments
Argument Description Example
source-file The source to create a reference from. Must be a URL. dotnet openapi add url https://contoso.com/openapi.json

Remove

Options
Short option Long option Description Example
-p --updateProject The project to operate on. dotnet openapi remove --updateProject .\Ref.csproj .\OpenAPI.json

Arguments

Argument Description Example
source-file The source to remove the reference to. dotnet openapi remove .\OpenAPI.json

Refresh

Options

Short option Long option Description Example
-p --updateProject The project to operate on. dotnet openapi refresh --updateProject .\Ref.csproj https://contoso.com/openapi.json

Arguments

Argument Description Example
source-file The URL to refresh the reference from. dotnet openapi refresh https://contoso.com/openapi.json