0 Fork 0

Files

T

John O'Keefe 8aa66a30fc docs(api): sync mirrors with the retired rules CRUD and the chain-order endpoint

Three mirrors had drifted:

- The rules-endpoint retirement (4f71eda6) deleted the routes but not
  their mirrors: removed docs/developer/api/collections/
  {add_auto_assign_rule,remove_auto_assign_rule,test_rule,update_rule}
  .md + their bruno twins, and pruned /api/collections/test-rules,
  /{id}/rules, /{id}/rules/{ruleId} from the generated openapi spec
  (hand-edited — regenerating with -update would wipe hand-authored
  bruno suites that predate the docs mirrors).
- New endpoint PUT /api/collections/:id/view-settings gets a doc page
  + schema-registry entry + bruno mirror (repo convention: the route
  and its docs land together).
- 54 pre-existing TestDocsMatchRoutes failures: the media-item
  endpoints emit the 16 episode/download fields (source_feed_id,
  feed_position, download_state, enclosure_url, hosts/guests, …) and
  libraries emit purpose/allow_member_feeds, but the doc examples
  were never extended — the package only runs on the host, so the
  container suite never caught it. Examples now carry every key the
  handlers emit; internal/docs is fully green.

2026-10-31 15:40:21 -04:00

1.4 KiB

Raw Blame History

method, path, auth, area

method	path	auth	area
POST	/api/libraries	jwt+admin	libraries

Create Library

Create a new library (Admin only).

Endpoint: POST /api/libraries Auth: Required (Admin only) Content-Type: application/json

Request Body

Field	Type	Required	Description
name	string	Yes	Library name
description	string	No	Library description
type	string	Yes	Library type (e.g., "ebooks", "comics", "audiobooks")

Example Request

{
  "name": "Comics Collection",
  "description": "Digital comics",
  "type": "comics"
}

Response (201 Created)

{
  "id": "uuid",
  "name": "Comics Collection",
  "description": "Digital comics",
  "created_at": "2026-01-31T10:00:00Z",
  "created_by_admin_id": null,
  "library_type_id": null,
  "updated_at": null,
  "allow_member_feeds": false
}

Error Responses

Code	Description
400	Invalid input data
401	Invalid or expired token
403	User is not an admin

1.4 KiB Raw Blame History