mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2024-12-20 19:06:06 +01:00
c5e60d30e1
* Add: `AudioTrack.yaml` * Fix: audiotrack example * Initial: podcast schemas and endpoints * Update schemas * Add: podcasts tag * Update bundled spec
91 lines
4.0 KiB
YAML
91 lines
4.0 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/settings:
|
|
$ref: './controllers/EmailController.yaml#/paths/~1api~1emails~1settings'
|
|
/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/podcasts:
|
|
$ref: './controllers/PodcastController.yaml#/paths/~1api~1podcasts'
|
|
/api/podcasts/feed:
|
|
$ref: './controllers/PodcastController.yaml#/paths/~1api~1podcasts~1feed'
|
|
/api/podcasts/opml:
|
|
$ref: './controllers/PodcastController.yaml#/paths/~1api~1podcasts~1opml'
|
|
/api/podcasts/{id}/checknew:
|
|
$ref: './controllers/PodcastController.yaml#/paths/~1api~1podcasts~1{id}~1checknew'
|
|
/api/podcasts/{id}/clear-queue:
|
|
$ref: './controllers/PodcastController.yaml#/paths/~1api~1podcasts~1{id}~1clear-queue'
|
|
/api/podcasts/{id}/downloads:
|
|
$ref: './controllers/PodcastController.yaml#/paths/~1api~1podcasts~1{id}~1downloads'
|
|
/api/podcasts/{id}/search-episode:
|
|
$ref: './controllers/PodcastController.yaml#/paths/~1api~1podcasts~1{id}~1search-episode'
|
|
/api/podcasts/{id}/download-episodes:
|
|
$ref: './controllers/PodcastController.yaml#/paths/~1api~1podcasts~1{id}~1download-episodes'
|
|
/api/podcasts/{id}/match-episodes:
|
|
$ref: './controllers/PodcastController.yaml#/paths/~1api~1podcasts~1{id}~1match-episodes'
|
|
/api/podcasts/{id}/episode/{episodeId}:
|
|
$ref: './controllers/PodcastController.yaml#/paths/~1api~1podcasts~1{id}~1episode~1{episodeId}'
|
|
/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
|
|
- name: Podcasts
|
|
description: Podcast endpoints
|