Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 14, 2025

Fixes #36331

Summary

No changes required. The commented xref block for AddOpenApiOperationTransformer was already removed from aspnetcore/fundamentals/openapi/customize-openapi.md in PR #36355 (merged Nov 14, 2025).

Details

The issue referenced commit a7b09b2cc which contained:

<!-- UPDATE 10.0 - API doc cross-link:
                   <xref:Microsoft.AspNetCore.Http.OpenApiRouteHandlerBuilderExtensions.AddOpenApiOperationTransformer%2A>
-->

PR #36355 removed this comment and updated the text to use the proper xref:

<xref:Microsoft.AspNetCore.Builder.OpenApiEndpointConventionBuilderExtensions.AddOpenApiOperationTransformer%2A>

Issue can be closed as completed.

Original prompt

This section details on the original issue you should resolve

<issue_title>Remove commented xref for endpoint specific operation transformers</issue_title>
<issue_description>> Note: Should this PR also include removing this comment:

https://github.com/dotnet/AspNetCore.Docs/blob/a7b09b2cca9f23d241350ac0b3d8917aa3b6904e/aspnetcore/fundamentals/openapi/customize-openapi.md?plain=1#L105C1-L111C114

I can also make this a separate PR :)

@wadepickett

Sure it can be the same PR, thanks!

Originally posted by @wadepickett in #36330 (comment)
</issue_description>

Comments on the Issue (you are @copilot in this section)

@wadepickett You were a fantastic help! Thanks @sander1095!!! @wadepickett . @wadepickett ## AI Analysis Report **Analyzed by:** @wadepickett **Date:** 2025-11-14 **Issue:** #36331 **Model:** GitHub Copilot ---

Issue Analysis: Remove commented xref for endpoint specific operation transformers

✅ Issue Validation

Status: Valid and actionable

📋 Issue Summary

The issue requests removal of a commented-out <xref> reference related to endpoint-specific operation transformers in the ASP.NET Core OpenAPI customization documentation. The commented code appears outdated or unnecessary, and its removal would clean up the documentation. The request specifically references lines 105–111 of customize-openapi.md.

📁 Affected Files

File Path Lines Section
Main article aspnetcore/fundamentals/openapi/customize-openapi.md 105-111 "Use operation transformers"

📝 Proposed Changes

Documentation Updates

File: customize-openapi.md
Location: Lines 105-111, preceding the paragraph explaining the use of AddOpenApiOperationTransformer.

Current content (lines 105-107):

<!-- UPDATE 10.0 - API doc cross-link:
                   <xref:Microsoft.AspNetCore.Http.OpenApiRouteHandlerBuilderExtensions.AddOpenApiOperationTransformer%2A>
-->

Proposed change:

  1. Remove the above commented block entirely; it serves no purpose in published documentation.

  2. Leave narrative line about AddOpenApiOperationTransformer unchanged, as it is correct and aligns with current best practices and .NET 10+ documentation.

🎯 Action Plan

  1. Edit file: aspnetcore/fundamentals/openapi/customize-openapi.md
    • Navigate to: Lines 105-111
    • Remove: The commented-out <xref> block pertaining to AddOpenApiOperationTransformer.

⚠️ Considerations

  • Verify that removal does not affect any automated docs generation (unlikely due to comment block format).
  • Check if similar commented cross-link references exist elsewhere in docs and flag for cleanup.
  • This change applies to .NET 10.0+ documentation context.

🔗 References


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI changed the title [WIP] Remove commented xref for endpoint specific operation transformers Close #36331 - Commented xref already removed in PR #36355 Nov 14, 2025
Copilot AI requested a review from wadepickett November 14, 2025 23:40
Copilot finished work on behalf of wadepickett November 14, 2025 23:40
@wadepickett
Copy link
Contributor

Closing. Copilot was too confused to handle this issue properly. Starting over.

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.

Remove commented xref for endpoint specific operation transformers

2 participants