decentraland / catalyst-api-specs

100%

main: 100%

push

github

break: document explorer endpoints and align the spec with catalyst and lamb2 (#158)

* feat: add docs for /explorer/{address}/wearables endpoint

* docs: remove comms and stats/parcels endpoints

Catalysts stopped routing /comms/* and /stats/parcels when the comms
services were removed from catalyst-owner (#219), and production returns
404 for them. Drop the four paths, their schemas and examples, the
Archipelago tag, and the COMMS_API export with its test.

BREAKING CHANGE: COMMS_API is no longer exported, and the generated
Islands, IslandId, Peers and StatsParcels client types are gone.

* docs: fix explorer wearables and add explorer emotes

Describe /explorer/{address}/wearables as lamb2 serves it: a
{elements, totalAmount, pageNum, pageSize} page whose elements are
either full (type, urn, name, category, amount, individualData,
entity, plus rarity/itemType for on-chain) or trimmed with `trimmed`.

Replace the nonexistent `sort` parameter with orderBy/direction, fix
the pageSize default (100, max 1000), and add the category, name,
rarity, trimmed, includeAmount, isSmartWearable and network filters,
plus the 400/502/503 error responses.

Add /explorer/{address}/emotes sharing the same parameters, with
full and trimmed examples taken from production.

* docs: align content server endpoints with the implementation

Correct the content server paths against the current catalyst code:
- document range, conditional and rate-limit responses for file
  downloads and item image/thumbnail (GET and HEAD)
- fix pagination params of the collection prefix endpoint and its
  example, add offset/limit to failed-deployments and offset to
  pointer-changes, with array-valued entityType filters
- return shapes: pointer-changes filters/pagination, failed
  deployment fields, status fields, audit fields actually returned
- document request limits and validation errors of POST
  /entities/active and GET /available-content
- add the deprecated GET /content/deployments a... (continued)

2 of 2 branches covered (100.0%)

Branch coverage included in aggregate %.

16 of 16 relevant lines covered (100.0%)

12.94 hits per line