Add support for generating OpenAPI parameters #55041
Merged
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
captainsafia
added
area-mvc
amcasey
approved these changes
Apr 10, 2024
captainsafia
added a commit
that referenced
this pull request
Apr 18, 2024
Co-authored-by: Martin Costello <[email protected]> Co-authored-by: Rick Anderson <[email protected]> This PR adds support for OpenAPI document generation, sans schema generation to Microsoft.AspNetCore.OpenApi. Relevant changes are available in individual PRs: - Add entry-point APIs for OpenAPI support (#54789) - Support resolving OpenApiPaths entries from document (#54847) - Support generating OpenAPI operation and associated fields (#54903) - Add APIs for OpenAPI document transformers (#54935) - Add support for generating OpenAPI parameters (#55041) - Add support for generating OpenAPI responses (#55020) - Add support for generating OpenAPI request bodies (#55040)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request adds support for populating parameters not sourced from the request body into the OpenAPI document.
Additions to
ApiDescriptionExtensions.cs:src/OpenApi/src/Extensions/ApiDescriptionExtensions.cs: A new methodIsRequestBodyParameterhas been added to determine if a givenApiParameterDescriptionis a request body parameter. This method checks if the parameter source is eitherBindingSource.Body,BindingSource.FormFile, orBindingSource.Form. TheMicrosoft.AspNetCore.Mvc.ModelBindingnamespace was also added to this file. [1] [2]Modifications to
OpenApiDocumentService.cs:src/OpenApi/src/Services/OpenApiDocumentService.cs: TheGetOperationmethod was modified to include parameters in the generatedOpenApiOperation. A new methodGetParameterswas added to generate a list ofOpenApiParameterfrom theApiDescription. This method filters out parameters that should be in the request body and populates the parameters list with the remaining parameters. TheMicrosoft.AspNetCore.Mvc.ModelBindingnamespace was also added to this file. [1] [2] [3]New test cases:
src/OpenApi/test/Services/OpenApiDocumentServiceTests.Parameters.cs: New test cases were added to verify the correct generation of parameter locations, the requiredness of route parameters, the requiredness of query parameters, the requiredness of header parameters, and the skipping of request body parameters. A new shared typeTodowas also added for use in the tests. [1] [2]