Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 18, 2025

Fixes #36331

The commented xref block for AddOpenApiOperationTransformer was already removed in PR #36336 (commit 593ba4f) on November 12, 2025.

The removal replaced the HTML comment with a proper xref cross-reference:

<!-- Before (removed in PR #36336) -->
<!-- UPDATE 10.0 - API doc cross-link:
                   <xref:Microsoft.AspNetCore.Http.OpenApiRouteHandlerBuilderExtensions.AddOpenApiOperationTransformer%2A>
-->

<!-- After (current state) -->
Operation transformers can also be added to specific endpoint with the <xref:Microsoft.AspNetCore.Builder.OpenApiEndpointConventionBuilderExtensions.AddOpenApiOperationTransformer%2A> API

No changes needed. This PR can be closed.

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)


Associated WorkItem - 509040</issue_description>

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

@wadepickett You were a fantastic help! Thanks @sander1095!!! @wadepickett Testing issue analysis and action plan copilot instructions... @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

  • Published article: Customize OpenAPI documents
  • Issue dotnet/AspNetCore.Docs#36331
  • Originating issue comment</comment_new>
    <comment_new>@wadepickett
    Coppilot seemed to have been confused over PR history. Some sort of odd event occured that day, I was seeing some copilot oddities for several different types of tasks, even simply assigning a date..
    Testing again to see if Copilot will do it correctly this time. It is a simple task of removing some content which it has handled before for other issues.</comment_new>

💬 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 Issue already resolved: Commented xref removed in PR #36336 Nov 18, 2025
Copilot AI requested a review from wadepickett November 18, 2025 00:09
Copilot finished work on behalf of wadepickett November 18, 2025 00:09
@wadepickett
Copy link
Contributor

Issue was already resolved in another PR by the time this PR was created. Closing.

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