API Reference
Coleções organizam recursos ou notas em grupos temáticos dentro do workspace. O campo isNoteCollection distingue coleções de notas de coleções de recursos.
GET /api/collection
Retorna todas as coleções do workspace.
Resposta 200
{
id: string;
name: string;
slug: string;
description: string | null;
color: string | null;
isNoteCollection: boolean;
userId: string;
workspaceId: string;
}[]
POST /api/collection
Cria uma nova coleção.
Corpo da requisição
| Campo | Tipo | Descrição |
|---|---|---|
name* | string | Nome da coleção |
description | string | Descrição |
color | string | Identificador de cor |
isNoteCollection | boolean | Define se é coleção de notas (padrão: false) |
Resposta 201
{
message: "Collection created successfully";
collection: {
id: string;
name: string;
slug: string;
description: string | null;
color: string | null;
isNoteCollection: boolean;
userId: string;
workspaceId: string;
};
}
PATCH /api/collection/[id]
Atualiza uma coleção existente.
Parâmetros de rota
| Parâmetro | Tipo | Descrição |
|---|---|---|
id | string | ID da coleção |
Corpo da requisição
| Campo | Tipo | Descrição |
|---|---|---|
name | string | Novo nome |
description | string | Nova descrição |
color | string | Nova cor |
Resposta 200
{
message: "Collection updated successfully";
collection: { id: string; name: string; description: string | null; color: string | null };
}
DELETE /api/collection/[id]
Remove uma coleção.
Resposta 200
{ message: "Collection deleted successfully" }
GET /api/collection/[id]/categories
Lista as categorias associadas aos recursos dentro de uma coleção específica.
Parâmetros de rota
| Parâmetro | Tipo | Descrição |
|---|---|---|
id | string | ID da coleção |
Resposta 200
{
id: string;
name: string;
slug: string;
_count: { resources: number };
}[]