mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2025-10-31 10:27:01 -04:00
7d05317357
* Initial notification schema * Add: notification event and settings schema * Add: NotificationController * Update bundled spec * Fix: `operationId` typos * Fix: library response to be arroy of objects * Fix: notification ID is not uuid * Add: `nullable` notification creation parameters * Nullable libraryId schema * Remove: `id` from Notification requestBody * Fix: `allOf` for `libraryItemSequence` * Fix: required `id` in wrong body * Fix: libraryItem typos * Update: bundled spec
59 lines
2.3 KiB
YAML
59 lines
2.3 KiB
YAML
openapi: 3.0.0
|
|
info:
|
|
title: Audiobookshelf API
|
|
version: 0.1.0
|
|
description: Audiobookshelf API with autogenerated OpenAPI doc
|
|
servers:
|
|
- url: http://localhost:3000
|
|
description: Development server
|
|
components:
|
|
securitySchemes:
|
|
BearerAuth:
|
|
description: Bearer authentication
|
|
type: http
|
|
scheme: bearer
|
|
security:
|
|
- BearerAuth: []
|
|
paths:
|
|
/api/authors/{id}:
|
|
$ref: './controllers/AuthorController.yaml#/paths/~1api~1authors~1{id}'
|
|
/api/authors/{id}/image:
|
|
$ref: './controllers/AuthorController.yaml#/paths/~1api~1authors~1{id}~1image'
|
|
/api/authors/{id}/match:
|
|
$ref: './controllers/AuthorController.yaml#/paths/~1api~1authors~1{id}~1match'
|
|
/api/libraries:
|
|
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries'
|
|
/api/libraries/{id}:
|
|
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries~1{id}'
|
|
/api/libraries/{id}/authors:
|
|
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries~1{id}~1authors'
|
|
/api/libraries/{id}/items:
|
|
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries~1{id}~1items'
|
|
/api/libraries/{id}/issues:
|
|
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries~1{id}~1issues'
|
|
/api/libraries/{id}/series:
|
|
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries~1{id}~1series'
|
|
/api/libraries/{id}/series/{seriesId}:
|
|
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries~1{id}~1series~1{seriesId}'
|
|
/api/notifications:
|
|
$ref: './controllers/NotificationController.yaml#/paths/~1api~1notifications'
|
|
/api/notificationdata:
|
|
$ref: './controllers/NotificationController.yaml#/paths/~1api~1notificationdata'
|
|
/api/notifications/test:
|
|
$ref: './controllers/NotificationController.yaml#/paths/~1api~1notifications~1test'
|
|
/api/notifications/{id}:
|
|
$ref: './controllers/NotificationController.yaml#/paths/~1api~1notifications~1{id}'
|
|
/api/notifications/{id}/test:
|
|
$ref: './controllers/NotificationController.yaml#/paths/~1api~1notifications~1{id}~1test'
|
|
/api/series/{id}:
|
|
$ref: './controllers/SeriesController.yaml#/paths/~1api~1series~1{id}'
|
|
tags:
|
|
- name: Authors
|
|
description: Author endpoints
|
|
- name: Libraries
|
|
description: Library endpoints
|
|
- name: Series
|
|
description: Series endpoints
|
|
- name: Notification
|
|
description: Notifications endpoints
|