audiobookshelf/docs/root.yaml
2024-07-04 03:45:04 +00:00

69 lines
2.8 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/emails:
$ref: './controllers/EmailController.yaml#/paths/~1api~1emails'
/api/emails/test:
$ref: './controllers/EmailController.yaml#/paths/~1api~1emails~1test'
/api/emails/ereader-devices:
$ref: './controllers/EmailController.yaml#/paths/~1api~1emails~1ereader-devices'
/api/emails/send-ebook-to-device:
$ref: './controllers/EmailController.yaml#/paths/~1api~1emails~1send-ebook-to-device'
/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: Email
description: Email endpoints
- name: Notification
description: Notifications endpoints