Collection on Cookifed

Retrieve the specified collection's items

Mon, 01 Jan 0001 00:00:00 +0000

GET /api/v1/collections/{id}/items

Returns all items in the specified collection as collection_item_output objects, each containing the item type and its full resource representation.

Required Scopes

read

Parameters

Name	In	Required	Type	Description
`id`	path	yes	integer

Request Body

None.

Responses

200

collection items

Schema: array[collection_item_output]

`collection_item_output`

Field	Type	Required
`id`	integer	yes
`type`	string	yes
`account`	`account_output`	yes
`object`	`short_eventable_output`	yes

Append a record to the collection

Mon, 01 Jan 0001 00:00:00 +0000

POST /api/v1/collections/{collection_id}/items/{id}

Add a recipe, baking, or status to the specified collection. Pass the resource’s numeric ID in the path and its type via the type query parameter.

Required Scopes

write

Parameters

Name	In	Required	Type
`collection_id`	path	yes	integer
`id`	path	yes	integer
`type`	query	yes	string

Request Body

None.

Responses

201

record appended

Remove a record from the collection

Mon, 01 Jan 0001 00:00:00 +0000

DELETE /api/v1/collections/{collection_id}/items/{id}

Remove the specified item from the collection. Identify the item by its numeric ID in the path and its type via the type query parameter.

Required Scopes

write

Parameters

Name	In	Required	Type
`collection_id`	path	yes	integer
`id`	path	yes	integer
`type`	query	yes	string

Request Body

None.

Responses

204

record removed

Retrieve all of the user's collections

Mon, 01 Jan 0001 00:00:00 +0000

GET /api/v1/collections

Returns collections belonging to the authenticated user, ordered by creation date. Use the /items endpoint to access a collection’s contents.

Required Scopes

read

Request Body

None.

Responses

200

collections list

Schema: array[collection_output]

`collection_output`

Field	Type	Required	Description
`id`	integer	yes
`name`	string	yes

Create a new collection

Mon, 01 Jan 0001 00:00:00 +0000

POST /api/v1/collections

Create a named collection for grouping recipes, bakings, and statuses. The name field is required and must be non-empty.

Required Scopes

write

Request Body

Content-Type: application/json

Schema: object

Field	Type	Required	Description
`collection`	`collection_input`	no

Responses

201

collection created

Schema: collection_output

`collection_output`

Field	Type	Required	Description
`id`	integer	yes
`name`	string	yes

422

invalid request

Schema: errors

`errors`

Field	Type	Required	Description
`errors`	object	yes

Retrieve the specified collection by its id

Mon, 01 Jan 0001 00:00:00 +0000

GET /api/v1/collections/{id}

Fetch a single collection by its numeric ID including its metadata. Use the /items endpoint to retrieve the full list of contained resources.

Required Scopes

read

Parameters

Name	In	Required	Type	Description
`id`	path	yes	integer

Request Body

None.

Responses

200

single collection

Schema: collection_output

`collection_output`

Field	Type	Required	Description
`id`	integer	yes
`name`	string	yes

Update an existing collection

Mon, 01 Jan 0001 00:00:00 +0000

PATCH /api/v1/collections/{id}

Update the specified collection’s attributes, such as its name. Only the owning account may perform updates on the collection.

Required Scopes

write

Parameters

Name	In	Required	Type	Description
`id`	path	yes	integer

Request Body

Content-Type: application/json

Schema: object

Field	Type	Required	Description
`collection`	`collection_input`	no

Responses

204

collection updated

422

invalid request

Schema: errors

`errors`

Field	Type	Required	Description
`errors`	object	yes

Delete a collection

Mon, 01 Jan 0001 00:00:00 +0000

DELETE /api/v1/collections/{id}

Permanently delete the specified collection and remove all its item associations. Only the owning account may delete it. This action cannot be undone.

Required Scopes

write

Parameters

Name	In	Required	Type	Description
`id`	path	yes	integer