Microsoft.extensions.api description.server allow specifying environment

[MattyLeslie]

Add Support for Specifying Environment During Swagger Generation with OpenApiGenerateEnvironment MSBuild Property

This pull request adds support for specifying the environment used during Swagger document generation in ASP.NET Core projects. By introducing the OpenApiGenerateEnvironment MSBuild property, users can control the environment configuration used when generating Swagger documentation during the build process.

Changes made:

1. Introduced OpenApiGenerateEnvironment MSBuild Property
2. Modified MSBuild Targets

Fixes #54698

[MattyLeslie]

@adityamandaleeka, may I please request a review on this.

[JoasE]

I don't think this will work because this just appends the --environment parameter to the dotnet-getdocument.dll command, which doesn't support the flag. I tested by using OpenApiGenerateDocumentsOptions tag as you can see in the code above can be used to accomplish appending the --environment parameter in the same way you are trying to do.

[MattyLeslie]

I don't think this will work because this just appends the --environment parameter to the dotnet-getdocument.dll command, which doesn't support the flag. I tested by using OpenApiGenerateDocumentsOptions tag as you can see in the code above can be used to accomplish appending the --environment parameter in the same way you are trying to do.

Thanks @JoasE, I have implemented the feedback, please let me know if that is fine. Many thanks

[captainsafia]

Posted a comment inline.

Also, I think there's more work involved here than I originally outlined in the issue.

We'll have to update the list of supported options in here and pipe the environment name through.

[captainsafia]

I'm a little bit nervous about pulling this out into a seperate property group since they are evaluated in order of appearance. I think it would make sense to tweak this a bit and include it in reference to _DotNetGeDocumentCommand like so:

<_DotNetGetDocumentCommand Condition=" '$(OpenApiGenerateEnvironment)' != '' " >--environment &quot;$(OpenApiGenerateEnvironment)&quot;</_DotNetGetDocumentCommand>

[MattyLeslie]

Not stale

[martincostello]

You need to close and re-open the PR so that the CI re-runs: #55836 (comment)

That's why the bot thinks the PR is stale.

[MattyLeslie]

You need to close and re-open the PR so that the CI re-runs: #55836 (comment)

That's why the bot thinks the PR is stale.

Thanks, I will do that.

[captainsafia]

@MattyLeslie Do you have any thoughts on this feedback comment?

[dotnet-policy-service]

Hello. I see that you've just added Needs: Author Feedback label to this PR.
That label is for Issues and not for PRs. Don't worry, I'm going to replace it with the correct one.

[dotnet-policy-service]

Hi @MattyLeslie.
It seems you haven't touched this PR for the last two weeks. To avoid accumulating old PRs, we're marking it as stale. As a result, it will be closed if no further activity occurs within 4 days of this comment. You can learn more about our Issue Management Policies here.