feat: add support for groups in @Schema and @Operation (fixes #4928) - #5278
Open
balu1225 wants to merge 2 commits into
Open
feat: add support for groups in @Schema and @Operation (fixes #4928)#5278balu1225 wants to merge 2 commits into
balu1225 wants to merge 2 commits into
Conversation
…-api#4928) - Added groups attribute to @Schema and @operation - Populated x-groups extension in generated OpenAPI Spec - Added tests ValidationGroupTest and OperationGroupsTest
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
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.
Pull Request
Thank you for contributing to swagger-core!
Please fill out the following information to help us review your PR efficiently.
Description
This PR adds support for the
groups()attribute in both@Schemaand@Operationannotations, allowing them to be serialized into the OpenAPI specification via thex-groupsextension.Class<?>[] groups() default {};to the@Schemaannotation.Class<?> groups() default Void.class;to the@Operationannotation.AnnotationsUtilsandModelResolverinswagger-coreto extract groups correctly and serialize them.Readerinswagger-jaxrs2to map thegroupsproperty from@Operationto thex-groupsextension on the final OpenAPIOperationobject.Fixes: #4928
Type of Change
Checklist
Screenshots / Additional Context
ValidationGroupTesttoswagger-coreto verify thatx-groupscorrectly propagates on standard fields and primitives in Schemas.OperationGroupsTesttoswagger-jaxrs2to verify thatx-groupscorrectly generates as a string for Operations.PetResourceTest#testSetOfClasseswas observed to be failing on upstreammasterindependently of these changes. All feature-specific tests are passing.