docs(jsonapi): document opt-in client-generated IDs#2287
Merged
Conversation
soyuka
force-pushed
the
feat/jsonapi-client-generated-id
branch
from
08da8e2 to
7e8445c
Compare
Add a "Client-Generated IDs" section to core/jsonapi.md covering the JSON:API spec allowance, the default 400 response, and how to opt in globally (Symfony YAML / Laravel config) or per-operation via denormalizationContext. References api-platform/core#7930 and spec §crud-creating-client-ids.
soyuka
force-pushed
the
feat/jsonapi-client-generated-id
branch
from
7e8445c to
b43aa05
Compare
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.
Summary
core/jsonapi.mdexplaining the JSON:API spec allowance (§crud-creating-client-ids) and API Platform's default refusal for security reasons.api_platform.jsonapi.allow_client_generated_id: true(Symfony YAML) and the equivalent Laravel config key.denormalizationContext: [ItemNormalizer::ALLOW_CLIENT_GENERATED_ID => true]on#[Post], with a complete code example and sample HTTP request.id; only thePOSTinput schema marks it as optional.Tracks: api-platform/core#7930 and api-platform/core#6738.
Test plan