decentraland / catalyst-api-specs / 38563075347

100%

push

github

feat: document partial deployments on post /entities (#171)

* feat: document partial deployments on post /entities

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.

* docs: document the partial query parameter on post /entities

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.

* docs: document 503, per-parcel 429 quotas and other post /entities statuses

Aligns the partial deployments spec with the Catalyst implementation:
- 400 only for requests that can never succeed; quota rejections are 429
- 429 lists the per-parcel, per-account, per-server and daily quotas
- 503 with Retry-After for transient conditions, including a failed
  publish of a completed upload, which stays live
- 408, 413 and 499
- the entity file read-back and Content-Length recommendation

* fix: tighten partial deployment details on post /entities

- partial query parameter and form field: drop the enum, other values
  are ignored (ADR-325) so strict validators don't reject them
- only the signer who started an upload may add batches
- Retry-After is required on 429
- drop 499, which no client can receive

* docs: cover remaining post /entities cases and trim internals

- replays answer 200 only with ?partial=true once the daily quota is spent
- multipart-parser 400s aren't counted against the daily quota
- every 413 cause, and the generic 500
- 429 causes as a list linking the ADR quotas; 503 without internals

0 of 2 branches covered (0.0%)

Branch coverage included in aggregate %.

14 of 16 relevant lines covered (87.5%)

1.25 hits per line