Fix IOpenApiDocumentProvider injection sample (keyed DI) #36426
Conversation
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
Author
|
@captainsafia FYI |
Collaborator
|
Hi @gabr0236! Sorry for the delay. I don't think Safia saw the ping. I sent her an email. Give her a little time to respond due to the holidays. Most of us are either totally OOF or working limited days until the first week of January. Happy New Year! 🥳 BTW ... Please resolve the conflict, so she can see the changes that you're requesting. |
Updates the `IOpenApiDocumentProvider` example in
`aspnetcore/fundamentals/openapi/using-openapi-documents.md` to:
* Inject the provider as a keyed service using `[FromKeyedServices("v1")]`.
* Call `GetOpenApiDocumentAsync` with an optional `CancellationToken` instead of a document name.
* Note that the service key `"v1"` must match the name passed to `AddOpenApi`.
The previous sample did not compile and did not reflect the keyed registration used by `AddOpenApi("v1")`.
Author
|
Hi @guardrex, no worries. I resolved the conflicts. Happy new years! |
Collaborator
|
Thanks! BTW ... You and Safia will work out the final details; but in passing, it seems like ...
For comparison and consideration (and I'm breaking the lines to adhere to our 85 character line length limit) ... public class CustomDocumentService(
[FromKeyedServices("v1")] IOpenApiDocumentProvider documentProvider)
{
public async Task<OpenApiDocument> GetApiDocumentAsync(
CancellationToken cancellationToken = default) =>
await documentProvider.GetOpenApiDocumentAsync(cancellationToken);
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Updates the IOpenApiDocumentProvider example in
aspnetcore/fundamentals/openapi/using-openapi-documents.mdto:The previous sample did not compile (because
GetOpenApiDocumentAsyncdoes not take a document name parameter) and did not reflect the keyed registration used byAddOpenApi("v1").Internal previews