Document custom IApiDescriptionProvider in MVC application model - #37601
Merged
wadepickett merged 4 commits intoSep 6, 2026
Merged
Conversation
Contributor
Author
|
@dotnet-policy-service agree
…On Sun, Sep 6, 2026 at 12:22 AM dotnet-policy-service[bot] < ***@***.***> wrote:
*dotnet-policy-service[bot]* left a comment (dotnet/AspNetCore.Docs#37601)
<#37601 (comment)>
@Skyrunner-Dev-ops <https://github.com/Skyrunner-Dev-ops> please read the
following Contributor License Agreement(CLA). If you agree with the CLA,
please reply with the following information.
@dotnet-policy-service agree [company="{your company}"]
Options:
- (default - no company specified) I have sole ownership of
intellectual property rights to my Submissions and I am not making
Submissions in the course of work for my employer.
@dotnet-policy-service agree
- (when company given) I am making Submissions in the course of work
for my employer (or my employer has intellectual property rights in my
Submissions by contract or applicable law). I have permission from my
employer to make Submissions and enter into this Agreement on behalf of my
employer. By signing below, the defined term “You” includes me and my
employer.
@dotnet-policy-service agree company="Microsoft"
Contributor License Agreement Contribution License Agreement
This Contribution License Agreement ( *“Agreement”* ) is agreed to by the
party signing below ( *“You”* ),
and conveys certain license rights to the .NET Foundation ( *“.NET
Foundation”* ) for Your contributions to
.NET Foundation open source projects. This Agreement is effective as of
the latest signature date below.
*1. Definitions.*
*“Code”* means the computer software code, whether in human-readable or
machine-executable form,
that is delivered by You to .NET Foundation under this Agreement.
*“Project”* means any of the projects owned or managed by .NET Foundation
and offered under a license
approved by the Open Source Initiative (www.opensource.org).
*“Submit”* is the act of uploading, submitting, transmitting, or
distributing code or other content to any
Project, including but not limited to communication on electronic mailing
lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of,
the Project for the purpose of
discussing and improving that Project, but excluding communication that is
conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
*“Submission”* means the Code and any other copyrightable material
Submitted by You, including any
associated comments and documentation.
*2. Your Submission.* You must agree to the terms of this Agreement
before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in
the future (except as
described in Section 4 below), Submit to any Project.
*3. Originality of Work.* You represent that each of Your Submissions is
entirely Your
original work. Should You wish to Submit materials that are not Your
original work,
You may Submit them separately to the Project if You (a) retain all
copyright and
license information that was in the materials as you received them, (b) in
the
description accompanying your Submission, include the phrase "Submission
containing materials of a third party:" followed by the names of the third
party and any
licenses or other restrictions of which You are aware, and (c) follow any
other
instructions in the Project's written guidelines concerning Submissions.
*4. Your Employer.* References to “employer” in this Agreement include
Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor,
vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your
employer has intellectual
property rights in Your Submission by contract or applicable law, You must
secure permission from Your
employer to make the Submission before signing this Agreement. In that
case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change
employers in the future and
desire to Submit additional Submissions for the new employer, then You
agree to sign a new Agreement
and secure permission from the new employer before Submitting those
Submissions.
*5. Licenses.*
*a. Copyright License.* You grant .NET Foundation, and those who receive
the Submission directly
or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive,
royalty-free, irrevocable
license in the Submission to reproduce, prepare derivative works of,
publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense
any or all of the foregoing
rights to third parties.
*b. Patent License.* You grant .NET Foundation, and those who receive the
Submission directly or
indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive,
royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission
or the combination of the
Submission with the Project to which it was Submitted to make, have made,
use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.
*c. Other Rights Reserved.* Each party reserves all rights not expressly
granted in this Agreement.
No additional licenses or rights whatsoever (including, without
limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.
*6. Representations and Warranties.* You represent that You are legally
entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your
original work (except as You may
have disclosed under Section 3 ). You represent that You have secured
permission from Your employer to
make the Submission in cases where Your Submission is made in the course
of Your work for Your
employer or Your employer has intellectual property rights in Your
Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You
represent and warrant that You
have the necessary authority to bind the listed employer to the
obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You
choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE
WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER
THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY
WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
*7. Notice to .NET Foundation.* You agree to notify .NET Foundation in
writing of any facts or
circumstances of which You later become aware that would make Your
representations in this
Agreement inaccurate in any respect.
*8. Information about Submissions.* You agree that contributions to
Projects and information about
contributions may be maintained indefinitely and disclosed publicly,
including Your name and other
information that You submit with Your Submission.
*9. Governing Law/Jurisdiction.* This Agreement is governed by the laws
of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal
courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which
case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County,
Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
*10. Entire Agreement/Assignment.* This Agreement is the entire agreement
between the parties, and
supersedes any and all prior agreements, understandings or communications,
written or oral, between
the parties relating to the subject matter hereof. This Agreement may be
assigned by .NET Foundation.
*.NET Foundation dedicates this Contribution License Agreement to the
public domain according to the Creative Commons CC0 1.*
—
Reply to this email directly, view it on GitHub
<#37601?email_source=notifications&email_token=BRCJ4DTXVJ66KXNYTZFT6NL5NROGRA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTKNJVGQYDGNRQHEY2M4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLDGN5XXIZLSL5RWY2LDNM#issuecomment-5554036091>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BRCJ4DTJZRUTPYBRXXKXMST5NROGRAVCNFSNUABEKJSXA33TNF2G64TZHMZDQMRTHE2DKNJ3JFZXG5LFHM2TGNRQGIYTGMRSGCQXMAQ>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Contributor
Author
|
@dotnet-policy-service agree
…On Sun, Sep 6, 2026 at 12:25 AM dotnet-policy-service[bot] < ***@***.***> wrote:
*dotnet-policy-service[bot]* left a comment (dotnet/AspNetCore.Docs#37601)
<#37601 (comment)>
@Skyrunner-Dev-ops <https://github.com/Skyrunner-Dev-ops> please read the
following Contributor License Agreement(CLA). If you agree with the CLA,
please reply with the following information.
@dotnet-policy-service agree [company="{your company}"]
Options:
- (default - no company specified) I have sole ownership of
intellectual property rights to my Submissions and I am not making
Submissions in the course of work for my employer.
@dotnet-policy-service agree
- (when company given) I am making Submissions in the course of work
for my employer (or my employer has intellectual property rights in my
Submissions by contract or applicable law). I have permission from my
employer to make Submissions and enter into this Agreement on behalf of my
employer. By signing below, the defined term “You” includes me and my
employer.
@dotnet-policy-service agree company="Microsoft"
Contributor License Agreement Contribution License Agreement
This Contribution License Agreement ( *“Agreement”* ) is agreed to by the
party signing below ( *“You”* ),
and conveys certain license rights to the .NET Foundation ( *“.NET
Foundation”* ) for Your contributions to
.NET Foundation open source projects. This Agreement is effective as of
the latest signature date below.
*1. Definitions.*
*“Code”* means the computer software code, whether in human-readable or
machine-executable form,
that is delivered by You to .NET Foundation under this Agreement.
*“Project”* means any of the projects owned or managed by .NET Foundation
and offered under a license
approved by the Open Source Initiative (www.opensource.org).
*“Submit”* is the act of uploading, submitting, transmitting, or
distributing code or other content to any
Project, including but not limited to communication on electronic mailing
lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of,
the Project for the purpose of
discussing and improving that Project, but excluding communication that is
conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
*“Submission”* means the Code and any other copyrightable material
Submitted by You, including any
associated comments and documentation.
*2. Your Submission.* You must agree to the terms of this Agreement
before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in
the future (except as
described in Section 4 below), Submit to any Project.
*3. Originality of Work.* You represent that each of Your Submissions is
entirely Your
original work. Should You wish to Submit materials that are not Your
original work,
You may Submit them separately to the Project if You (a) retain all
copyright and
license information that was in the materials as you received them, (b) in
the
description accompanying your Submission, include the phrase "Submission
containing materials of a third party:" followed by the names of the third
party and any
licenses or other restrictions of which You are aware, and (c) follow any
other
instructions in the Project's written guidelines concerning Submissions.
*4. Your Employer.* References to “employer” in this Agreement include
Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor,
vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your
employer has intellectual
property rights in Your Submission by contract or applicable law, You must
secure permission from Your
employer to make the Submission before signing this Agreement. In that
case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change
employers in the future and
desire to Submit additional Submissions for the new employer, then You
agree to sign a new Agreement
and secure permission from the new employer before Submitting those
Submissions.
*5. Licenses.*
*a. Copyright License.* You grant .NET Foundation, and those who receive
the Submission directly
or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive,
royalty-free, irrevocable
license in the Submission to reproduce, prepare derivative works of,
publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense
any or all of the foregoing
rights to third parties.
*b. Patent License.* You grant .NET Foundation, and those who receive the
Submission directly or
indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive,
royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission
or the combination of the
Submission with the Project to which it was Submitted to make, have made,
use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.
*c. Other Rights Reserved.* Each party reserves all rights not expressly
granted in this Agreement.
No additional licenses or rights whatsoever (including, without
limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.
*6. Representations and Warranties.* You represent that You are legally
entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your
original work (except as You may
have disclosed under Section 3 ). You represent that You have secured
permission from Your employer to
make the Submission in cases where Your Submission is made in the course
of Your work for Your
employer or Your employer has intellectual property rights in Your
Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You
represent and warrant that You
have the necessary authority to bind the listed employer to the
obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You
choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE
WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER
THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY
WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
*7. Notice to .NET Foundation.* You agree to notify .NET Foundation in
writing of any facts or
circumstances of which You later become aware that would make Your
representations in this
Agreement inaccurate in any respect.
*8. Information about Submissions.* You agree that contributions to
Projects and information about
contributions may be maintained indefinitely and disclosed publicly,
including Your name and other
information that You submit with Your Submission.
*9. Governing Law/Jurisdiction.* This Agreement is governed by the laws
of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal
courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which
case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County,
Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
*10. Entire Agreement/Assignment.* This Agreement is the entire agreement
between the parties, and
supersedes any and all prior agreements, understandings or communications,
written or oral, between
the parties relating to the subject matter hereof. This Agreement may be
assigned by .NET Foundation.
*.NET Foundation dedicates this Contribution License Agreement to the
public domain according to the Creative Commons CC0 1.*
—
Reply to this email directly, view it on GitHub
<#37601?email_source=notifications&email_token=BRCJ4DQCUHSJG4JKYP77YYL5NROTBA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTKNJVGQYDKNJXG432M4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLDGN5XXIZLSL5RWY2LDNM#issuecomment-5554055777>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BRCJ4DU3UPRUV7WDJ25NHTL5NROTBAVCNFSNUABEKJSXA33TNF2G64TZHMZDQMRTHE2DKNJ3JFZXG5LFHM2TGNRQGIYTGMRSGCQXMAQ>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Added versioning and included information about built-in OpenAPI document generation in .NET 9 and updated guidance on using IApiDescriptionProvider.
wadepickett
self-requested a review
September 5, 2026 22:25
Contributor
|
@Skyrunner-Dev-ops, Thanks so much for this contribution, ! This is solid work. Your IApiDescriptionProvider write-up is technically accurate: I verified the execution order (OnProvidersExecuting ascending, OnProvidersExecuted reverse), the default provider's Order = -1000, the ApiDescription.Properties usage, and the TryAddEnumerable registration against the dotnet/aspnetcore source, and they all check out. The code samples compile and follow the framework's own registration idiom. I made one structural change on top of your work to account for how OpenAPI has evolved across versions in ASP.NET Core, and I want to walk you through it so the reasoning is clear: What changed in the platform: .NET 9 introduced built-in OpenAPI document generation via the Microsoft.AspNetCore.OpenApi package (AddOpenApi/MapOpenApi). For customizing generated output, the recommended approach is now document, operation, and schema transformers — not implementing IApiDescriptionProvider directly. What I changed (now in commit b3c6f20, lines 221–282): Split the section by version using monikers, following the existing WebApiCompatShim moniker pattern already in this article:
One small follow-up: we should bump ms.date in the frontmatter to today's date since the file changed substantially. I've assigned @tdykstra for a final look. Thanks again for jumping in on this! If this looks good to you after the structural change I made and the current ms.author signs off I think this is good to publish now myself and approve. The PR does not address all of what the original Issue called out, but that issue is so old it is way out of date now. I think the scope you hit here is right and we can consider it closing the issue. |
wadepickett
reviewed
Sep 5, 2026
Updated the article date.
Contributor
|
@tdykstra, could use yor review on this. |
wadepickett
approved these changes
Sep 6, 2026
wadepickett
left a comment
wadepickett
left a comment
Contributor
There was a problem hiding this comment.
Approved after we versioned the new information.
Contributor
|
Thanks again @Skyrunner-Dev-ops! This is going live today. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…8465)
Fixes #8465
Description
IApiDescriptionProviderimplementations constructApiDescriptionmetadata forApiExplorerModel, which OpenAPI/Swagger doc generators rely upon. Previously,aspnetcore/mvc/controllers/application-model.mdexplained application model conventions andApiExplorerModel, but lacked documentation on customIApiDescriptionProviderimplementations.This PR adds a
### Custom API description providers with IApiDescriptionProvidersubsection under## Use ApiExplorer to document an appinaspnetcore/mvc/controllers/application-model.md.Changes
IApiDescriptionProviderand its execution order methods (OnProvidersExecutingandOnProvidersExecuted).IApiDescriptionProviderthat enrichesApiDescriptioninstances with custom metadata.IApiDescriptionProviderimplementations in DI usingbuilder.Services.TryAddEnumerable(ServiceDescriptor.Transient<IApiDescriptionProvider, ...>()).Internal previews
Build report