Move MapOpenApi() Inside the IsDevelopment() block for consistency wi… #34541
Conversation
…th templates and other docs The default template with .NET 9 has MapOpenApi() inside the IsDevelopment block. Many examples on MS Learn also have it inside due to limit information exposure. Move inside to minimize potential for confusion to devs.
|
@davepcallan, thanks for calling this out and providing an example update! See and address Contributor License Agreement request above before we can continue. I will update for the rest of the code that is sectioned with preprocessor directives (only the #Default sample originally used the Develpment environment condition, likely for simplicity's sake in the doc examples). I will also verify the documents referring to the code still display correctly with the changes. |
|
@dotnet-policy-service agree |
| @@ -3,7 +3,6 @@ | |||
| //#define DOCUMENTtransformer1 | |||
| //#define DOCUMENTtransformer2 | |||
| #define DOCUMENTtransformerUse999 | |||
There was a problem hiding this comment.
Removed dupe preprocessor directive for default.
| @@ -80,7 +79,10 @@ internal record WeatherForecast(DateTime Date, int TemperatureC, string? Summary | |||
|
|
|||
| var app = builder.Build(); | |||
|
|
|||
| app.MapOpenApi(); | |||
| if (app.Environment.IsDevelopment()) | |||
There was a problem hiding this comment.
Added Development environment condition for all calls to app.MapOpenAPI() and tested each.
Line 501, moved app.MapOpenAPI() to same environment condition block for app.MapScalarApiReference()
|
Some code highlighting is off a few lines as a result in topics that refer to the code. Three topics use the code inline. Only one had a highlighting alignment issue. Updating that... |
|
@captainsafia, is this change to move app.MapOpenApi() within the condition of isDevelopment OK with you? The #defualt code had one but the other examples did not. I also reviewed topics referring to the sample and updated a code highlight. Thanks in advance. |
…th templates and other docs
The default template with .NET 9 has MapOpenApi() inside the IsDevelopment block. Many examples on MS Learn also have it inside due to limit information exposure.
Move inside to minimize potential for confusion to devs.
Internal previews