Repository navigation
feat: document partial deployments on post /entities - #171
Open
LautaroPetaccio wants to merge 2 commits into
Open
LautaroPetaccio wants to merge 2 commits into
LautaroPetaccio wants to merge 2 commits into
Conversation
Adds the multipart `partial` field and the entity-file-optional rule for
resumed batches, the 202 `{ missing }` response (generated as
PostEntity202), terminal 400 semantics for partial uploads, and the
partial-only 429 with its Retry-After header, following ADR-325.
Test this pull request
|
Batches may declare partial=true in the URL so the server knows before reading the body. Documents the parameter, the 400 when it comes without the matching form field, and the daily-quota 429 a batch can get when it omits it.
This branch has not been deployed
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.
What
Documents the partial (batched) deployment protocol from decentraland/adr#325 on
POST /entities:partialmultipart field, and when the entity file may be omitted.202 { missing: string[] }response, generated asPostEntity202.400as terminal for partial uploads too (validation, expiry, newer entity, quotas).429with aRetry-Afterheader for partial deployments.Notes
Generated artifacts aren't tracked, so only the OpenAPI source changes;
yarn testpasses.dcl-catalyst-client(decentraland/catalyst-client#491) keeps a local 202 type until this is released, then needs a version bump.