Category
5 operations generated from the Engine OpenAPI schema. Request and response model names can be expanded in the interactive schema.
GET /api/v1/categories
List all Categories.
Authentication: Authorization header (ApiKeyAuth)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
POST /api/v1/categories
Create a Category.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
category | body | app.Category | Yes | Category to create |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
DELETE /api/v1/categories/{id}
Delete a Category by name.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Category name |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
GET /api/v1/categories/{id}
Get a Category by name.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Category name |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
PATCH /api/v1/categories/{id}
Update a Category by name.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Category name |
category | body | app.Category | Yes | Category settings |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |