Skip to content

docs: Update OpenApiVersion description #63613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 10, 2025
Merged

docs: Update OpenApiVersion description #63613

merged 1 commit into from
Sep 10, 2025

Conversation

xC0dex
Copy link
Contributor

@xC0dex xC0dex commented Sep 10, 2025

Update OpenApiVersion description

  • You've read the Contributor Guide and Code of Conduct.
  • You've included unit or integration tests for your change, where applicable.
  • You've included inline docs for your change, where applicable.
  • There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.

Summary

While developing, I noticed that the summary for the OpenApiVersion property incorrectly referenced OpenApi3_0 as the default. This PR updates the comment to correctly reference OpenApi3_1.

@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Sep 10, 2025
@github-actions github-actions bot added the needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically label Sep 10, 2025
@xC0dex xC0dex marked this pull request as ready for review September 10, 2025 10:04
@Copilot Copilot AI review requested due to automatic review settings September 10, 2025 10:04
@xC0dex xC0dex requested review from a team and captainsafia as code owners September 10, 2025 10:04
Copilot
Copilot AI reviewed Sep 10, 2025
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR corrects documentation for the OpenApiVersion property in OpenApiOptions to accurately reflect the default value. The XML documentation comment previously incorrectly stated that the default was OpenApi3_0, when the actual default value is OpenApi3_1.

Key Changes

  • Updated XML documentation comment to reference the correct default value

@martincostello martincostello added feature-openapi area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc and removed needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically labels Sep 10, 2025
mikekistler
mikekistler approved these changes Sep 10, 2025
View reviewed changes
Copy link
Contributor

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

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

Looks good. 👍

Thank you for this fix.

@captainsafia
Copy link
Member

/ba-g This is just a doc comment fix.

@captainsafia captainsafia merged commit 6ccaf8c into dotnet:main Sep 10, 2025
27 of 31 checks passed
@dotnet-policy-service dotnet-policy-service bot added this to the 11.0-preview1 milestone Sep 10, 2025
@xC0dex xC0dex deleted the docs/update-openapi-version branch September 22, 2025 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@captainsafia captainsafia captainsafia approved these changes

@mikekistler mikekistler mikekistler approved these changes

+1 more reviewer

@WeihanLi WeihanLi WeihanLi approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc community-contribution Indicates that the PR has been added by a community member feature-openapi

Projects

None yet

Milestone

11.0-preview1

Development

Successfully merging this pull request may close these issues.

5 participants

@xC0dex @captainsafia @WeihanLi @mikekistler @martincostello