Skip to content

Documents the OpenApiGenerationEnvironment MSBuild property - #37589

Merged
wadepickett merged 4 commits into
dotnet:mainfrom
snemeckayova:snemeckayova/#68949-OpenApiGenerationEnvironment
Sep 4, 2026
Merged

Documents the OpenApiGenerationEnvironment MSBuild property#37589
wadepickett merged 4 commits into
dotnet:mainfrom
snemeckayova:snemeckayova/#68949-OpenApiGenerationEnvironment

Conversation

@snemeckayova

@snemeckayova snemeckayova commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the OpenApiGenerationEnvironment MSBuild property introduced by dotnet/aspnetcore#63856.

Changes

  • aspnetcore-openapi.md: Explains how to select the app environment used during build-time OpenAPI document generation.
  • openapi-generation-environment-preview-7.md: Adds the .NET 11 feature announcement, configuration example, and contributor acknowledgment.
  • aspnetcore-11.md: Adds the new OpenAPI release-note include.

Fixes dotnet/aspnetcore#68949


Internal previews

File Preview link
aspnetcore/fundamentals/openapi/aspnetcore-openapi.md Learn preview
aspnetcore/release-notes/aspnetcore-11.md Learn preview
aspnetcore/release-notes/aspnetcore-11/includes/openapi-generation-environment.md Learn preview

Build report

@Youssef1313

This comment was marked as resolved.

Comment thread aspnetcore/fundamentals/openapi/aspnetcore-openapi.md

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wadepickett For other features, it looks like we are not consistent in file names whether we use the preview version number in file name or not. Do you have recommendation?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Youssef1313, You are right, it is not consistant, thanks for pointing out the issue. I don't see a reason for keeping the preview versions in the file name for the What's new include files. I think they just started that way long ago at some point and then were perpetuated. I think even the current AI agent related to this is includijng them, which I'll fix.

.
So this:
aspnetcore/release-notes/aspnetcore-11/includes/openapi-generation-environment-preview-7.md

Would become:
aspnetcore/release-notes/aspnetcore-11/includes/openapi-generation-environment.md

I will fix all of them in a new PR after this one.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went ahead and fixed the new file name here. I will correct the rest of them in a new PR.

@wadepickett wadepickett left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@snemeckayova & @Youssef1313: Approved. This looks great, I did not find any new issues. I did update the file name of the new What's New include file.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Youssef1313, You are right, it is not consistant, thanks for pointing out the issue. I don't see a reason for keeping the preview versions in the file name for the What's new include files. I think they just started that way long ago at some point and then were perpetuated. I think even the current AI agent related to this is includijng them, which I'll fix.

.
So this:
aspnetcore/release-notes/aspnetcore-11/includes/openapi-generation-environment-preview-7.md

Would become:
aspnetcore/release-notes/aspnetcore-11/includes/openapi-generation-environment.md

I will fix all of them in a new PR after this one.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went ahead and fixed the new file name here. I will correct the rest of them in a new PR.

@wadepickett

Copy link
Copy Markdown
Contributor

Since I made the last commit I think we need one more approval from you @Youssef1313 in order to merge.

Was this intended to merge to live rigth away today or wait until the next .NET 11 release?

@Youssef1313 Youssef1313 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Given this shipped in Preview 7 already, I think it's fine to go live.

@wadepickett

Copy link
Copy Markdown
Contributor

LGTM.

Given this shipped in Preview 7 already, I think it's fine to go live.

I didn't know if we were adding anything newer in the mix of it. Got it. Thanks, will go live now.

@wadepickett
wadepickett merged commit c6120ec into dotnet:main Sep 4, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document OpenApiGenerationEnvironment MSBuild property

3 participants