docs(validation): document validation groups effect on generated schema#2292
Merged
Merged
Conversation
Grouped constraints leave the Default group (Symfony semantics), so they are invisible in generated JSON Schema / OpenAPI unless the operation declares matching groups via validationContext. Also documents the callable limitation: dynamic groups cannot be reflected in the static schema. Refs api-platform/core#6500
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
1 participant
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.
Documents how validation groups interact with JSON Schema / OpenAPI generation.
When a constraint declares an explicit
groups:option it leaves theDefaultgroup (standard Symfony semantics). Since schema is generated per-operation, grouped constraints are not reflected unless the operation declares the matching groups viavalidationContext: ['groups' => [...]]. Also documents the callable-groups limitation: dynamic groups resolved at runtime cannot appear in the static schema.Documents the behavior reported in api-platform/core#6500.