Skip to content

Commit

Permalink
docs: adjust documentation
Browse files Browse the repository at this point in the history
Refs: #1021
  • Loading branch information
Phil91 committed Sep 24, 2024
1 parent 48a827f commit f9a8d73
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To execute the generation of the open api document the .csproj file of the proje
<Target Name="openapi" AfterTargets="Build">
<Message Text="generating openapi v$(Version)" Importance="high" />
<Exec Command="dotnet tool restore" />
<Exec Command="dotnet tool run swagger tofile --yaml --output ../../../docs/api/$(AssemblyName).yaml $(OutputPath)$(AssemblyName).dll v$(Version)" EnvironmentVariables="DOTNET_ROLL_FORWARD=LatestMajor;ASPNETCORE_ENVIRONMENT=Swagger;MVC_ROUTING_BASEPATH=api/administration" />
<Exec Command="dotnet tool run swagger tofile --yaml --output ../../../docs/api/$(AssemblyName).yaml $(OutputPath)$(AssemblyName).dll v$(Version)" EnvironmentVariables="DOTNET_ROLL_FORWARD=LatestMajor;SKIP_CONFIGURATION_VALIDATION=true;MVC_ROUTING_BASEPATH=api/administration" />
</Target>
```

Expand All @@ -38,7 +38,7 @@ The `dotnet tool run swagger tofile` is executed with the following parameters:

> **IMPORTANT**: the version set for the output must(!) match with the version which is specified in the `Program.cs` more under [Setup Program](#setup-program)
3. `EnvironmentVariables="DOTNET_ROLL_FORWARD=LatestMajor;ASPNETCORE_ENVIRONMENT=Swagger"` sets the environment variables to start up the program. The environment of the application is set to swagger to skip the application configuration validation
1. `EnvironmentVariables="DOTNET_ROLL_FORWARD=LatestMajor;SKIP_CONFIGURATION_VALIDATION=true"` sets the environment variables to start up the program. With the variable `SKIP_CONFIGURATION_VALIDATION` the configuration validation is skipped when starting the application

## Setup Program

Expand Down

0 comments on commit f9a8d73

Please sign in to comment.