mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2025-10-31 02:17:01 -04:00
107 lines
3.0 KiB
YAML
107 lines
3.0 KiB
YAML
components:
|
|
schemas:
|
|
emailSettings:
|
|
type: string
|
|
description: The field to sort by from the request.
|
|
example: 'media.metadata.title'
|
|
responses:
|
|
email200:
|
|
description: Successful response - Email
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../objects/settings/EmailSettings.yaml#/components/schemas/EmailSettings'
|
|
ereader200:
|
|
description: Successful response - Ereader
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
ereaderDevices:
|
|
type: array
|
|
items:
|
|
$ref: '../objects/settings/EmailSettings.yaml#/components/schemas/EreaderDeviceObject'
|
|
paths:
|
|
/api/emails/settings:
|
|
get:
|
|
summary: Get email settings
|
|
description: Get email settings for sending e-books to e-readers.
|
|
operationId: getEmailSettings
|
|
tags:
|
|
- Email
|
|
responses:
|
|
200:
|
|
$ref: '#/components/responses/email200'
|
|
patch:
|
|
summary: Update email settings
|
|
operationId: updateEmailSettings
|
|
tags:
|
|
- Email
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../objects/settings/EmailSettings.yaml#/components/schemas/EmailSettings'
|
|
responses:
|
|
200:
|
|
$ref: '#/components/responses/email200'
|
|
/api/emails/test:
|
|
post:
|
|
summary: Send test email
|
|
operationId: sendTestEmail
|
|
tags:
|
|
- Email
|
|
responses:
|
|
200:
|
|
description: Successful response
|
|
/api/emails/ereader-devices:
|
|
post:
|
|
summary: Update e-reader devices
|
|
operationId: updateEReaderDevices
|
|
tags:
|
|
- Email
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
ereaderDevices:
|
|
type: array
|
|
items:
|
|
$ref: '../objects/settings/EmailSettings.yaml#/components/schemas/EreaderDeviceObject'
|
|
responses:
|
|
200:
|
|
$ref: '#/components/responses/ereader200'
|
|
400:
|
|
description: Invalid payload
|
|
/api/emails/send-ebook-to-device:
|
|
post:
|
|
summary: Send ebook to device
|
|
operationId: sendEBookToDevice
|
|
tags:
|
|
- Email
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
libraryItemId:
|
|
$ref: '../objects/LibraryItem.yaml#/components/schemas/libraryItemId'
|
|
deviceName:
|
|
$ref: '../objects/settings/EmailSettings.yaml#/components/schemas/ereaderName'
|
|
responses:
|
|
200:
|
|
description: Successful response
|
|
400:
|
|
description: Invalid request
|
|
403:
|
|
description: Forbidden
|
|
404:
|
|
description: Not found
|