Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ Maintainerr exposes lightweight health endpoints under `/api/health` (prefixed w
| `POST /api/collections/:id/poster` | Upload a custom collection poster with multipart field `poster`; returns `{ pushed, attempted }` |
| `DELETE /api/collections/:id/poster` | Clear the stored poster and return `{ cleared, refreshRequested }` |

The lower-level `POST /api/media-server/collection` request body matches `CreateCollectionParams`: `libraryId`, `title`, and `type` are required, with optional `summary`, `sortTitle`, and `initialItemId`. `initialItemId` is a single media-server item id used when a collection must be created with one initial member; remaining items are still added afterwards through the normal collection-sync path.

### Metadata

| Endpoint | Purpose |
Expand Down
31 changes: 31 additions & 0 deletions static/openapi-spec/maintainerr_api_specs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -743,6 +743,12 @@ paths:
post:
operationId: MediaServerController_createCollection
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCollectionParams'
responses:
'201':
description: ''
Expand Down Expand Up @@ -2122,6 +2128,31 @@ components:
type: boolean
recommended:
type: boolean
CreateCollectionParams:
type: object
properties:
libraryId:
type: string
title:
type: string
summary:
type: string
type:
type: string
enum:
- movie
- show
- season
- episode
sortTitle:
type: string
initialItemId:
type: string
description: Optional id of a single media-server item to include when the collection is created.
required:
- libraryId
- title
- type
RulesDto:
type: object
properties: {}
Expand Down