Catalog API
The Catalog API manages collection settings: the named document and media folders that structure a store's content. A collection is a document-collection or a media-collection resource, with its key as the JSON:API id. Mount a catalog with buildJsonApi from contentia/catalog-api. Like every Contentia API server, it requires an access policy.
Every response carries Cache-Control: no-store.
List all collections
/collectionsResponses
All configured collections.
/collectionsSamples
Create a collection
/collectionsWrites the collection under data.id, replacing any existing collection with that key.
Request Body
Responses
The submitted collection as decoded, echoed back; it is not read back from the settings provider.
/collectionsSamples
Read a single collection
/collections/{key}Responses
The requested collection.
/collections/{key}Samples
Delete a collection
Update a collection
/collections/{key}The submitted attributes replace the collection's settings; they are not merged with the stored ones.
Request Body
Responses
The submitted collection as decoded, echoed back; it is not read back from the settings provider.
/collections/{key}