Initial library endpoints (#3012)

* Fix: extra type in `Author.yaml`

* Fix: formatting

* Initial library schema

* Additional debugging

* Fix: spec relative paths

* Add: ebook file spec

* Fix: response type should be string

* Linting updates

* Add: missing librarySettings

* Temporary fix: Library cron can be null or false

* Author controller updates

* Add: `/api/libraries/{id}` endpoint

* Update library responses

* Add: descriptions

* Fix: queries should be in body

* Fix: `body` should be `requestBody`

* Move: `libraryController` paths, clean up `requestBody`

* Clean up libraryController parameters

* Move: author endpoints to controller

* Add `get` for author images

* Simplify author schema with items

* Remove: unused response type

* Update: formatting

* Update json

* Update requestBody on LibraryController

* LibrarySettings update

* Replace: generic parameter with path specific parameter

* Fix: requestBody descriptions

* Fix: match post operation

* Temporary: nullable Author schemas

* LibraryController items endpoint

* Add: delete library items with issues

* Massive cleanup and violation fixing

* Update bundled spec

* Add: remove library items with issues

* Add: library items endpoint

* Fix: errors

* Fix: base schemas

* Add: series schemas

* Add: library series endpoint

* Fix: oneOf and array issues

* Add: author search region for matching

* Add: series endpoints

* Fix: series issues

* Add library series endpoint and update deprecation

* Fix: series endpoint deprecation

* Fix: `name` in `sortDesc` schema

* Add: workflow for linting spec

* Update OpenAPI readme

.github/workflows/lint-openapi.yml

@@ -0,0 +1,30 @@
+name: API linting
+
+# Run on pull requests or pushes when there is a change to the OpenAPI file
+on:
+  push:
+    paths:
+      - docs/
+  pull_request:
+    paths:
+      - docs/
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Check out the repository
+      - name: Checkout
+        uses: actions/checkout@v4
+      # Set up node to run the javascript
+      - name: Set up node
+        uses: actions/setup-node@v4
+      # Install Redocly CLI
+      - name: Install Redocly CLI
+        run: npm install -g @redocly/cli@latest
+      # Perform linting for exploded spec
+      - name: Run linting for exploded spec
+        run: redocly lint docs/root.yaml --format=github-actions
+      # Perform linting for bundled spec
+      - name: Run linting for bundled spec
+        run: redocly lint docs/openapi.json --format=github-actions

docs/README.md

@@ -1,30 +1,33 @@
 # OpenAPI specification
 
-This directory includes the OpenAPI spec for the ABS server.
-The spec is made up of a number of individual `yaml` files located here and in the subfolders, with `root.yaml` being the file that references all of the others.
-The files are organized to have the same hierarchy as the server source files.
-The full spec is bundled into one file in `openapi.json`.
+This directory includes the OpenAPI spec for the ABS server. The spec is made up of a number of individual `yaml` files located here and in the subfolders, with `root.yaml` being the file that references all of the others. The files are organized to have the same hierarchy as the server source files. The full spec is bundled into one file in `openapi.json`.
 
-The spec is linted and bundled by the [`vacuum` tool](https://quobix.com/vacuum/).
-The spec can also be tested with a real server using the [`wiretap` tool](https://pb33f.io/wiretap/).
-Both of these tools are created by [pb33f](https://pb33f.io/).
+The spec is linted and bundled using [`redocly-cli`](https://redocly.com/docs/cli/). This tool also generates HTML docs for the spec.
+
+The tools created by [`pb33f`](https://pb33f.io/), specifically `vacuum` and `wiretap`, are also useful for linting and verification. These tools check for some other things, such as validating requests to and responses from the server.
 
 ### Bundling the spec
-The command to bundle the spec into a `yaml` file is `vacuum bundle root.yaml openapi.yaml`.
 
-The current version of `vacuum` cannot convert input `yaml` files to `json` files.
-To convert the spec to `json`, you can use the `yq` tool or another tool.
+The command used to bundle the spec into a `yaml` file is `redocly bundle root.yaml > bundled.yaml`.
 
-The command to convert the spec using `yq` is `yq -p yaml -o json openapi.yaml > openapi.json`.
+The `yq` tool is used to convert the `yaml` to a `json` using the `yq -p yaml -o json bundled.yaml > openapi.json`.
 
-### Viewing report
-To generate an HTML report, you can use `vacuum html-report [file]` to generate `report.html` and view the report in your browser.
+### Linting the spec
+
+The command used to lint the spec is `redocly lint root.yaml`
+
+To generate an HTML report using `vacuum`, you can use `vacuum html-report [file]` to generate `report.html` and view the report in your browser.
+
+### Generating documentation
+
+Redocly allows for creating a static HTML page to document the API. This is done by using `redocly build-docs [file]` and supports exploded specs.
 
 ### Putting it all together
-The full command that I run to bundle the spec and generate the report is:
+
+The full command that I run to bundle the spec and generate the documentation is:
 
 ```
-vacuum bundle root.yaml openapi.yaml && \
-yq -p yaml -o json openapi.yaml > openapi.json && \
-vacuum html-report openapi.json
+redocly bundle root.yaml > bundled.yaml && \
+yq -p yaml -o json bundled.yaml > openapi.json && \
+redocly build-docs openapi.json
 ```

docs/controllers/AuthorController.yaml

@@ -4,136 +4,291 @@ components:
       description: Whether the author was updated without errors. Will not exist if author was merged.
       type: boolean
       nullable: true
-  parameters:
-    authorId:
-      name: id
-      in: path
-      description: Author ID
-      required: true
-      schema:
-        $ref: '../objects/entities/Author.yaml#/components/schemas/authorId'
+    authorMerged:
+      description: Whether the author was merged with another author. Will not exist if author was updated.
+      type: boolean
+      nullable: true
     authorInclude:
-      name: include
-      in: query
-      description: A comma separated list of what to include with the author. The options are `items` and `series`. `series` will only have an effect if `items` is included.
-      required: false
-      schema:
-        type: string
-        example: "items"
-      examples:
-        empty:
-          summary: Do not return library items
-          value: ""
-        itemOnly:
-          summary: Only return library items
-          value: "items"
-        itemsAndSeries:
-          summary: Return library items and series
-          value: "items,series"
+      description: A comma separated list of what to include with the author. The options are `items` and `series`. `series` will only have an effect if `items` is included. For example, the value `items,series` will include both library items and series.
+      type: string
+      example: 'items'
     authorLibraryId:
-      name: library
-      in: query
-      description: The ID of the library to to include filter included items from.
-      required: false
-      schema:
-        $ref: '../objects/Library.yaml#/components/schemas/libraryId'
-    asin:
-      name: asin
-      in: query
-      description: The Audible Identifier (ASIN).
-      required: false
-      schema:
-        $ref: '../objects/entities/Author.yaml#/components/schemas/authorAsin'
+      $ref: '../objects/Library.yaml#/components/schemas/libraryId'
     authorSearchName:
-      name: q
-      in: query
       description: The name of the author to use for searching.
-      required: false
-      schema:
-        type: string
-        example: Terry Goodkind
+      type: string
+      example: Terry Goodkind
     authorName:
-      name: name
-      in: query
-      description: The new name of the author.
-      required: false
-      schema:
-        $ref: '../objects/entities/Author.yaml#/components/schemas/authorName'
-    authorDescription:
-      name: description
-      in: query
-      description: The new description of the author.
-      required: false
-      schema:
-        type: string
-        nullable: true
-        example: Terry Goodkind is a #1 New York Times Bestselling Author and creator of the critically acclaimed masterwork, ‘The Sword of Truth’. He has written 30+ major, bestselling novels, has been published in more than 20 languages world-wide, and has sold more than 26 Million books. ‘The Sword of Truth’ is a revered literary tour de force, comprised of 17 volumes, borne from over 25 years of dedicated writing.
-    authorImagePath:
-      name: imagePath
-      in: query
-      description: The new absolute path for the author image.
-      required: false
-      schema:
-        type: string
-        nullable: true
-        example: /metadata/authors/aut_z3leimgybl7uf3y4ab.jpg
+      $ref: '../objects/entities/Author.yaml#/components/schemas/authorName'
     imageUrl:
-      name: url
-      in: query
       description: The URL of the image to add to the server
-      required: true
-      schema:
-        type: string
-        format: uri
-        example: https://images-na.ssl-images-amazon.com/images/I/51NoQTm33OL.__01_SX120_CR0,0,120,120__.jpg
+      type: string
+      format: uri
+      example: https://images-na.ssl-images-amazon.com/images/I/51NoQTm33OL.__01_SX120_CR0,0,120,120__.jpg
     imageWidth:
-      name: width
-      in: query
       description: The requested width of image in pixels.
-      schema:
-        type: integer
-        default: 400
-        example: 400
+      type: integer
+      default: 400
       example: 400
     imageHeight:
-      name: height
-      in: query
       description: The requested height of image in pixels. If `null`, the height is scaled to maintain aspect ratio based on the requested width.
-      schema:
-        type: integer
-        nullable: true
-        default: null
-        example: 600
-      examples:
-        scaleHeight:
-          summary: Scale height with width
-          value: null
-        fixedHeight:
-          summary: Force height of image
-          value: 600
+      type: integer
+      nullable: true
+      default: null
+      example: 600
     imageFormat:
-      name: format
-      in: query
       description: The requested output format.
-      schema:
-        type: string
-        default: jpeg
-        example: webp
+      type: string
+      default: jpeg
+      example: webp
     imageRaw:
-      name: raw
-      in: query
       description: Return the raw image without scaling if true.
-      schema:
-        type: boolean
-        default: false
-  responses: 
+      type: boolean
+      default: false
+  responses:
+    author200:
+      description: Author found.
+      content:
+        application/json:
+          schema:
+            $ref: '../objects/entities/Author.yaml#/components/schemas/author'
     author404:
       description: Author not found.
       content:
         text/html:
           schema:
             type: string
-            example: Not found
-tags:
-  - name: Authors
-    description: Author endpoints
+            example: Author not found.
+paths:
+  /api/authors/{id}:
+    parameters:
+      - name: id
+        in: path
+        description: Author ID
+        required: true
+        schema:
+          $ref: '../objects/entities/Author.yaml#/components/schemas/authorId'
+    get:
+      operationId: getAuthorById
+      summary: Get an author by ID
+      description: Get an author by ID. The author's books and series can be included in the response.
+      tags:
+        - Authors
+      requestBody:
+        required: false
+        description: The author object to create.
+        content:
+          application/json:
+            schema:
+              properties:
+                include:
+                  $ref: '#/components/schemas/authorInclude'
+                library:
+                  $ref: '#/components/schemas/authorLibraryId'
+      responses:
+        '200':
+          description: getAuthorById OK
+          content:
+            application/json:
+              schema:
+                $ref: '../objects/entities/Author.yaml#/components/schemas/author'
+        '404':
+          $ref: '#/components/responses/author404'
+    patch:
+      operationId: updateAuthorById
+      summary: Update an author by ID
+      description: Update an author by ID. The author's name and description can be updated. This endpoint will merge two authors if the new author name matches another author name in the database.
+      tags:
+        - Authors
+      requestBody:
+        description: The author object to update.
+        content:
+          application/json:
+            schema:
+              properties:
+                name:
+                  $ref: '#/components/schemas/authorName'
+                description:
+                  $ref: '../objects/entities/Author.yaml#/components/schemas/authorDescription'
+                imagePath:
+                  $ref: '../objects/entities/Author.yaml#/components/schemas/authorImagePath'
+                asin:
+                  $ref: '../objects/entities/Author.yaml#/components/schemas/authorAsin'
+      responses:
+        '200':
+          description: updateAuthorById OK
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: '../objects/entities/Author.yaml#/components/schemas/author'
+                  - $ref: '#/components/schemas/authorUpdated'
+                  - $ref: '#/components/schemas/authorMerged'
+        '404':
+          $ref: '#/components/responses/author404'
+    delete:
+      operationId: deleteAuthorById
+      summary: Delete an author by ID
+      description: Delete an author by ID. This will remove the author from all books.
+      tags:
+        - Authors
+      responses:
+        '200':
+          description: deleteAuthorById OK
+          content:
+            text/plain:
+              schema:
+                type: string
+                example: Author deleted.
+        '404':
+          $ref: '#/components/responses/author404'
+  /api/authors/{id}/image:
+    parameters:
+      - name: id
+        in: path
+        description: Author ID
+        required: true
+        schema:
+          $ref: '../objects/entities/Author.yaml#/components/schemas/authorId'
+    get:
+      operationId: getAuthorImageById
+      summary: Get an author image by author ID
+      description: Get an author image by author ID. The image will be returned in the requested format and size.
+      tags:
+        - Authors
+      requestBody:
+        required: false
+        description: The author image to get.
+        content:
+          application/json:
+            schema:
+              properties:
+                width:
+                  $ref: '#/components/schemas/imageWidth'
+                height:
+                  $ref: '#/components/schemas/imageHeight'
+                format:
+                  $ref: '#/components/schemas/imageFormat'
+                raw:
+                  $ref: '#/components/schemas/imageRaw'
+      responses:
+        '200':
+          description: getAuthorImageById OK
+          content:
+            image/webp:
+              schema:
+                type: string
+                format: binary
+            image/jpeg:
+              schema:
+                type: string
+                format: binary
+            image/*:
+              schema:
+                type: string
+                format: binary
+        '404':
+          $ref: '#/components/responses/author404'
+    post:
+      operationId: addAuthorImageById
+      summary: Add an author image to the server
+      description: Add an author image to the server. The image will be downloaded from the provided URL and stored on the server.
+      tags:
+        - Authors
+      requestBody:
+        required: true
+        description: The author image to add by URL.
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/imageUrl'
+      responses:
+        '200':
+          description: addAuthorImageById OK
+          content:
+            image/*:
+              schema:
+                type: string
+                format: binary
+        '404':
+          $ref: '#/components/responses/author404'
+    patch:
+      operationId: updateAuthorImageById
+      summary: Update an author image by author ID
+      description: Update an author image by author ID. The image will be resized if the width, height, or format is provided.
+      tags:
+        - Authors
+      requestBody:
+        description: The author image to update.
+        content:
+          application/json:
+            schema:
+              properties:
+                width:
+                  $ref: '#/components/schemas/imageWidth'
+                height:
+                  $ref: '#/components/schemas/imageHeight'
+                format:
+                  $ref: '#/components/schemas/imageFormat'
+                raw:
+                  $ref: '#/components/schemas/imageRaw'
+      responses:
+        '200':
+          description: updateAuthorImageById OK
+          content:
+            image/*:
+              schema:
+                type: string
+                format: binary
+        '404':
+          $ref: '#/components/responses/author404'
+    delete:
+      operationId: deleteAuthorImageById
+      summary: Delete an author image by author ID
+      description: Delete an author image by author ID. This will remove the image from the server and the database.
+      tags:
+        - Authors
+      responses:
+        '200':
+          description: deleteAuthorImageById OK
+        '404':
+          $ref: '#/components/responses/author404'
+  /api/authors/{id}/match:
+    parameters:
+      - name: id
+        in: path
+        description: Author ID
+        required: true
+        schema:
+          $ref: '../objects/entities/Author.yaml#/components/schemas/authorId'
+    post:
+      operationId: matchAuthorById
+      summary: Match the author against Audible using quick match
+      description: Match the author against Audible using quick match. Quick match updates the author's description and image (if no image already existed) with information from audible. Either `asin` or `q` must be provided, with `asin` taking priority if both are provided.
+      tags:
+        - Authors
+      requestBody:
+        required: true
+        description: The author object to match against an online provider.
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                q:
+                  $ref: '#/components/schemas/authorSearchName'
+                asin:
+                  $ref: '../objects/entities/Author.yaml#/components/schemas/authorAsin'
+                region:
+                  $ref: '../schemas.yaml#/components/schemas/region'
+      responses:
+        '200':
+          description: matchAuthorById OK
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: '../objects/entities/Author.yaml#/components/schemas/author'
+                  - $ref: '#/components/schemas/authorUpdated'
+        '404':
+          $ref: '#/components/responses/author404'

docs/controllers/LibraryController.yaml

@@ -0,0 +1,435 @@
+components:
+  schemas:
+    sortBy:
+      type: string
+      description: The field to sort by from the request.
+      example: 'media.metadata.title'
+    sortDesc:
+      description: Whether to sort in descending order.
+      type: boolean
+      example: true
+    filterBy:
+      type: string
+      description: The field to filter by from the request. TODO
+      example: 'media.metadata.title'
+    collapseSeries:
+      type: boolean
+      description: Whether collapse series was set in the request.
+      example: true
+    libraryFolders:
+      description: The folders of the library. Only specify the fullPath.
+      type: array
+      items:
+        $ref: '../objects/Folder.yaml#/components/schemas/folder'
+    libraryDisplayOrder:
+      description: The display order of the library. Must be >= 1.
+      type: integer
+      minimum: 1
+      example: 1
+    libraryIcon:
+      description: The icon of the library. See Library Icons for a list of possible icons.
+      type: string
+      example: 'audiobookshelf'
+    libraryMediaType:
+      description: The type of media that the library contains. Must be `book` or `podcast`.
+      type: string
+      example: 'book'
+    libraryProvider:
+      description: Preferred metadata provider for the library. See Metadata Providers for a list of possible providers.
+      type: string
+      example: 'audible'
+    librarySettings:
+      $ref: '../objects/Library.yaml#/components/schemas/librarySettings'
+    librarySort:
+      description: The sort order of the library. For example, to sort by title use 'sort=media.metadata.title'.
+      type: string
+      example: 'media.metadata.title'
+    libraryFilter:
+      description: The filter for the library.
+      type: string
+      example: 'media.metadata.title'
+    libraryCollapseSeries:
+      description: Whether to collapse series.
+      type: boolean
+      example: true
+      default: false
+    libraryInclude:
+      description: The fields to include in the response. The only current option is `rssfeed`.
+      type: string
+      example: 'rssfeed'
+  responses:
+    library200:
+      description: Library found.
+      content:
+        application/json:
+          schema:
+            $ref: '../objects/Library.yaml#/components/schemas/library'
+    library404:
+      description: Library not found.
+      content:
+        text/html:
+          schema:
+            type: string
+            example: Library not found.
+paths:
+  /api/libraries:
+    get:
+      operationId: getLibraries
+      summary: Get all libraries on server
+      description: Get all libraries on server.
+      tags:
+        - Libraries
+      responses:
+        '200':
+          description: getLibraries OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '../objects/Library.yaml#/components/schemas/library'
+    post:
+      operationId: createLibrary
+      summary: Create a new library on server
+      description: Create a new library on server.
+      tags:
+        - Libraries
+      requestBody:
+        description: The library object to create.
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [name, folders]
+              properties:
+                name:
+                  $ref: '../objects/Library.yaml#/components/schemas/libraryName'
+                folders:
+                  $ref: '#/components/schemas/libraryFolders'
+                displayOrder:
+                  $ref: '#/components/schemas/libraryDisplayOrder'
+                icon:
+                  $ref: '#/components/schemas/libraryIcon'
+                mediaType:
+                  $ref: '#/components/schemas/libraryMediaType'
+                provider:
+                  $ref: '#/components/schemas/libraryProvider'
+                settings:
+                  $ref: '#/components/schemas/librarySettings'
+      responses:
+        '200':
+          $ref: '#/components/responses/library200'
+        '404':
+          $ref: '#/components/responses/library404'
+  /api/libraries/{id}:
+    parameters:
+      - name: id
+        in: path
+        description: The ID of the library.
+        required: true
+        schema:
+          $ref: '../objects/Library.yaml#/components/schemas/libraryId'
+    get:
+      operationId: getLibraryById
+      summary: Get a single library by ID on server
+      description: Get a single library by ID on server.
+      tags:
+        - Libraries
+      responses:
+        '200':
+          $ref: '#/components/responses/library200'
+        '404':
+          $ref: '#/components/responses/library404'
+    patch:
+      operationId: updateLibraryById
+      summary: Update a single library by ID on server
+      description: Update a single library by ID on server.
+      tags:
+        - Libraries
+      requestBody:
+        required: true
+        description: The library object to update.
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                name:
+                  $ref: '../objects/Library.yaml#/components/schemas/libraryName'
+                folders:
+                  $ref: '#/components/schemas/libraryFolders'
+                displayOrder:
+                  $ref: '#/components/schemas/libraryDisplayOrder'
+                icon:
+                  $ref: '#/components/schemas/libraryIcon'
+                mediaType:
+                  $ref: '#/components/schemas/libraryMediaType'
+                provider:
+                  $ref: '#/components/schemas/libraryProvider'
+                settings:
+                  $ref: '#/components/schemas/librarySettings'
+      responses:
+        '200':
+          $ref: '#/components/responses/library200'
+        '404':
+          $ref: '#/components/responses/library404'
+    delete:
+      operationId: deleteLibraryById
+      summary: Delete a single library by ID on server
+      description: Delete a single library by ID on server and return the deleted object.
+      tags:
+        - Libraries
+      responses:
+        '200':
+          $ref: '#/components/responses/library200'
+        '404':
+          $ref: '#/components/responses/library404'
+  /api/libraries/{id}/issues:
+    parameters:
+      - name: id
+        in: path
+        description: The ID of the library.
+        required: true
+        schema:
+          $ref: '../objects/Library.yaml#/components/schemas/libraryId'
+    delete:
+      operationId: deleteLibraryIssues
+      summary: Delete items with issues in a library.
+      description: Delete all items with issues in a library by library ID on the server. This only removes the items from the ABS database and does not delete media files.
+      tags:
+        - Libraries
+      responses:
+        '200':
+          description: deleteLibraryIssues OK
+          content:
+            application/json:
+              schema:
+                type: string
+                example: 'Issues deleted.'
+        '404':
+          $ref: '#/components/responses/library404'
+  /api/libraries/{id}/items:
+    parameters:
+      - name: id
+        in: path
+        description: The ID of the library.
+        required: true
+        schema:
+          $ref: '../objects/Library.yaml#/components/schemas/libraryId'
+    get:
+      operationId: getLibraryItems
+      summary: Get items in a library
+      description: Get items in a library by ID on server.
+      tags:
+        - Libraries
+      requestBody:
+        required: false
+        description: The filters to apply to the requested library items.
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                limit:
+                  $ref: '../schemas.yaml#/components/schemas/limit'
+                page:
+                  $ref: '../schemas.yaml#/components/schemas/page'
+                sort:
+                  $ref: '#/components/schemas/librarySort'
+                desc:
+                  $ref: '../schemas.yaml#/components/schemas/sortDesc'
+                filter:
+                  $ref: '#/components/schemas/libraryFilter'
+                minified:
+                  $ref: '../schemas.yaml#/components/schemas/minified'
+                collapseSeries:
+                  $ref: '#/components/schemas/libraryCollapseSeries'
+                include:
+                  $ref: '#/components/schemas/libraryInclude'
+      responses:
+        '200':
+          description: getLibraryItems OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  results:
+                    type: array
+                    items:
+                      $ref: '../objects/LibraryItem.yaml#/components/schemas/libraryItemBase'
+                  total:
+                    $ref: '../schemas.yaml#/components/schemas/total'
+                  limit:
+                    $ref: '../schemas.yaml#/components/schemas/limit'
+                  page:
+                    $ref: '../schemas.yaml#/components/schemas/page'
+                  sortBy:
+                    $ref: '#/components/schemas/sortBy'
+                  sortDesc:
+                    $ref: '#/components/schemas/sortDesc'
+                  filterBy:
+                    $ref: '#/components/schemas/filterBy'
+                  mediaType:
+                    $ref: '../objects/mediaTypes/media.yaml#/components/schemas/mediaType'
+                  minified:
+                    $ref: '../schemas.yaml#/components/schemas/minified'
+                  collapseSeries:
+                    $ref: '#/components/schemas/collapseSeries'
+                  include:
+                    $ref: '#/components/schemas/libraryInclude'
+        '404':
+          $ref: '#/components/responses/library404'
+  /api/libraries/{id}/authors:
+    parameters:
+      - name: id
+        in: path
+        description: The ID of the library.
+        required: true
+        schema:
+          $ref: '../objects/Library.yaml#/components/schemas/libraryId'
+    get:
+      operationId: getLibraryAuthors
+      summary: Get all authors in a library
+      description: Get all authors in a library by ID on server.
+      tags:
+        - Libraries
+      responses:
+        '200':
+          description: getLibraryAuthors OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  authors:
+                    type: array
+                    items:
+                      $ref: '../objects/entities/Author.yaml#/components/schemas/authorExpanded'
+        '404':
+          $ref: '#/components/responses/library404'
+  /api/libraries/{id}/series:
+    parameters:
+      - name: id
+        in: path
+        description: The ID of the library.
+        required: true
+        schema:
+          $ref: '../objects/Library.yaml#/components/schemas/libraryId'
+    get:
+      operationId: getLibrarySeries
+      summary: Get library series
+      description: Get series in a library. Filtering and sorting can be applied.
+      tags:
+        - Libraries
+      requestBody:
+        required: false
+        description: The filters to apply to the requested library series.
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                limit:
+                  $ref: '../schemas.yaml#/components/schemas/limit'
+                page:
+                  $ref: '../schemas.yaml#/components/schemas/page'
+                sort:
+                  description: The field to sort by from the request.
+                  type: string
+                  enum: ['name', 'numBooks', 'totalDuration', 'addedAt', 'lastBookAdded', 'lastBookUpdated']
+                  example: 'numBooks'
+                  default: 'name'
+                desc:
+                  $ref: '../schemas.yaml#/components/schemas/sortDesc'
+                filter:
+                  $ref: '#/components/schemas/libraryFilter'
+                include:
+                  $ref: '#/components/schemas/libraryInclude'
+      responses:
+        '200':
+          description: getLibrarySeries OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  results:
+                    type: array
+                    items:
+                      $ref: '../objects/entities/Series.yaml#/components/schemas/seriesBooks'
+                  total:
+                    $ref: '../schemas.yaml#/components/schemas/total'
+                  limit:
+                    $ref: '../schemas.yaml#/components/schemas/limit'
+                  page:
+                    $ref: '../schemas.yaml#/components/schemas/page'
+                  sortBy:
+                    $ref: '#/components/schemas/sortBy'
+                  sortDesc:
+                    $ref: '#/components/schemas/sortDesc'
+                  filterBy:
+                    $ref: '#/components/schemas/filterBy'
+                  minified:
+                    $ref: '../schemas.yaml#/components/schemas/minified'
+                  include:
+                    $ref: '#/components/schemas/libraryInclude'
+
+        '404':
+          $ref: '#/components/responses/library404'
+  /api/libraries/{id}/series/{seriesId}:
+    parameters:
+      - name: id
+        in: path
+        description: The ID of the library.
+        required: true
+        schema:
+          $ref: '../objects/Library.yaml#/components/schemas/libraryId'
+      - name: seriesId
+        in: path
+        description: The ID of the series.
+        required: true
+        schema:
+          $ref: '../objects/entities/Series.yaml#/components/schemas/seriesId'
+    get:
+      operationId: getLibrarySeriesById
+      summary: Get single series in library
+      description: Get a single series in a library by ID on server. This endpoint is deprecated and `/api/series/{id}` should be used instead.
+      deprecated: true
+      tags:
+        - Libraries
+      requestBody:
+        required: false
+        description: The filters to apply to the requested library series.
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                limit:
+                  $ref: '../schemas.yaml#/components/schemas/limit'
+                page:
+                  $ref: '../schemas.yaml#/components/schemas/page'
+                sort:
+                  description: The field to sort by from the request.
+                  type: string
+                  enum: ['name', 'numBooks', 'totalDuration', 'addedAt', 'lastBookAdded', 'lastBookUpdated']
+                  example: 'numBooks'
+                  default: 'name'
+                desc:
+                  $ref: '../schemas.yaml#/components/schemas/sortDesc'
+                filter:
+                  $ref: '#/components/schemas/libraryFilter'
+                minified:
+                  $ref: '../schemas.yaml#/components/schemas/minified'
+                include:
+                  $ref: '#/components/schemas/libraryInclude'
+      responses:
+        '200':
+          description: getLibrarySeriesById OK
+          content:
+            application/json:
+              schema:
+                $ref: '../objects/entities/Series.yaml#/components/schemas/seriesWithProgressAndRSS'
+        '404':
+          $ref: '#/components/responses/library404'

docs/controllers/SeriesController.yaml

@@ -0,0 +1,72 @@
+components:
+  responses:
+    series404:
+      description: Series not found.
+      content:
+        text/html:
+          schema:
+            type: string
+            example: Series not found.
+paths:
+  /api/series/{id}:
+    parameters:
+      - name: id
+        in: path
+        description: The ID of the series.
+        required: true
+        schema:
+          $ref: '../objects/entities/Series.yaml#/components/schemas/seriesId'
+    get:
+      operationId: getSeries
+      tags:
+        - Series
+      summary: Get series
+      description: Get a series by ID.
+      requestBody:
+        required: false
+        description: A comma separated list of what to include with the series.
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                include:
+                  type: string
+                  description: A comma separated list of what to include with the series.
+                  example: 'progress,rssfeed'
+                  enum: ['progress', 'rssfeed', 'progress,rssfeed', 'rssfeed,progress']
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '../objects/entities/Series.yaml#/components/schemas/seriesWithProgressAndRSS'
+        '404':
+          $ref: '#/components/responses/series404'
+    patch:
+      operationId: updateSeries
+      tags:
+        - Series
+      summary: Update series
+      description: Update a series by ID.
+      requestBody:
+        required: true
+        description: The series to update.
+        content:
+          application/json:
+            schema:
+              properties:
+                name:
+                  $ref: '../objects/entities/Series.yaml#/components/schemas/seriesName'
+                description:
+                  $ref: '../objects/entities/Series.yaml#/components/schemas/seriesDescription'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '../objects/entities/Series.yaml#/components/schemas/series'
+        '404':
+          $ref: '#/components/responses/series404'

docs/objects/Library.yaml

@@ -3,10 +3,96 @@ components:
     oldLibraryId:
       type: string
       description: The ID of the libraries created on server version 2.2.23 and before.
-      format: "lib_[a-z0-9]{18}"
-      example: lib_o78uaoeuh78h6aoeif
+      format: 'lib_[a-z0-9]{18}'
+      example: 'lib_o78uaoeuh78h6aoeif'
     libraryId:
       type: string
       description: The ID of the library.
       format: uuid
-      example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b
+      example: 'e4bb1afb-4a4f-4dd6-8be0-e615d233185b'
+    libraryName:
+      description: The name of the library.
+      type: string
+      example: My Audiobooks
+    librarySettings:
+      description: The settings for the library.
+      type: object
+      properties:
+        coverAspectRatio:
+          description: Whether the library should use square book covers. Must be 0 (for false) or 1 (for true).
+          type: integer
+          example: 1
+        disableWatcher:
+          description: Whether to disable the folder watcher for the library.
+          type: boolean
+          example: false
+        skipMatchingMediaWithAsin:
+          description: Whether to skip matching books that already have an ASIN.
+          type: boolean
+          example: false
+        skipMatchingMediaWithIsbn:
+          description: Whether to skip matching books that already have an ISBN.
+          type: boolean
+          example: false
+        autoScanCronExpression:
+          description: The cron expression for when to automatically scan the library folders. If null, automatic scanning will be disabled.
+          type: string
+          nullable: true
+          example: '0 0 0 * * *'
+        audiobooksOnly:
+          description: Whether the library should ignore ebook files and only allow ebook files to be supplementary.
+          type: boolean
+          example: false
+        hideSingleBookSeries:
+          description: Whether to hide series with only one book.
+          type: boolean
+          example: false
+        onlyShowLaterBooksInContinueSeries:
+          description: Whether to only show books in a series after the highest series sequence.
+          type: boolean
+          example: false
+        metadataPrecedence:
+          description: The precedence of metadata sources. See Metadata Providers for a list of possible providers.
+          type: array
+          items:
+            type: string
+          example: ['folderStructure', 'audioMetatags', 'nfoFile', 'txtFiles', 'opfFile', 'absMetadata']
+        podcastSearchRegion:
+          description: The region to use when searching for podcasts.
+          type: string
+          example: 'us'
+    library:
+      description: A library object which includes either books or podcasts.
+      type: object
+      properties:
+        id:
+          $ref: '#/components/schemas/libraryId'
+        name:
+          $ref: '#/components/schemas/libraryName'
+        folders:
+          description: The folders that belong to the library.
+          type: array
+          items:
+            $ref: './Folder.yaml#/components/schemas/folder'
+        displayOrder:
+          description: Display position of the library in the list of libraries. Must be >= 1.
+          type: integer
+          example: 1
+        icon:
+          description: The selected icon for the library. See Library Icons for a list of possible icons.
+          type: string
+          example: 'audiobookshelf'
+        mediaType:
+          description: The type of media that the library contains. Will be `book` or `podcast`. (Read Only)
+          type: string
+          example: 'book'
+        provider:
+          description: Preferred metadata provider for the library. See Metadata Providers for a list of possible providers.
+          type: string
+          example: 'audible'
+        settings:
+          $ref: '#/components/schemas/librarySettings'
+        createdAt:
+          $ref: '../schemas.yaml#/components/schemas/createdAt'
+        lastUpdate:
+          $ref: '../schemas.yaml#/components/schemas/updatedAt'

docs/objects/LibraryItem.yaml

@@ -4,7 +4,7 @@ components:
       description: The ID of library items on server version 2.2.23 and before.
       type: string
       nullable: true
-      format: "li_[a-z0-9]{18}"
+      format: 'li_[a-z0-9]{18}'
       example: li_o78uaoeuh78h6aoeif
     libraryItemId:
       type: string
@@ -59,8 +59,14 @@ components:
       type: object
       description: A single item on the server, like a book or podcast. Minified media format.
       allOf:
-        - $ref : '#/components/schemas/libraryItemBase'
+        - $ref: '#/components/schemas/libraryItemBase'
         - type: object
           properties:
             media:
               $ref: './mediaTypes/media.yaml#/components/schemas/mediaMinified'
+    libraryItemSequence:
+      type: object
+      description: A single item on the server, like a book or podcast. Includes series sequence information.
+      allOf:
+        - $ref: '#/components/schemas/libraryItemBase'
+        - $ref: './entities/Series.yaml#/components/schemas/sequence'

docs/objects/entities/Author.yaml

@@ -6,14 +6,24 @@ components:
       format: uuid
       example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b
     authorAsin:
-      type: string
       description: The Audible identifier (ASIN) of the author. Will be null if unknown. Not the Amazon identifier.
+      type: string
       nullable: true
       example: B000APZOQA
     authorName:
       description: The name of the author.
       type: string
       example: Terry Goodkind
+    authorDescription:
+      description: The new description of the author.
+      type: string
+      nullable: true
+      example: Terry Goodkind is a #1 New York Times Bestselling Author and creator of the critically acclaimed masterwork, ‘The Sword of Truth’. He has written 30+ major, bestselling novels, has been published in more than 20 languages world-wide, and has sold more than 26 Million books. ‘The Sword of Truth’ is a revered literary tour de force, comprised of 17 volumes, borne from over 25 years of dedicated writing.
+    authorImagePath:
+      description: The absolute path for the author image. This will be in the `metadata/` directory. Will be null if there is no image.
+      type: string
+      nullable: true
+      example: /metadata/authors/aut_z3leimgybl7uf3y4ab.jpg
     authorSeries:
       type: object
       description: Series and the included library items that an author has written.
@@ -26,9 +36,9 @@ components:
           description: The items in the series. Each library item's media's metadata will have a `series` attribute, a `Series Sequence`, which is the matching series.
           type: array
           items:
-            ref: '../LibraryItem.yaml#/components/schemas/libraryItemMinified'
+            $ref: '../LibraryItem.yaml#/components/schemas/libraryItemMinified'
     author:
-      description: An author object which includes a description and image path.
+      description: An author object which includes a description and image path. The library items and series associated with the author are optionally included.
       type: object
       properties:
         id:
@@ -38,51 +48,23 @@ components:
         name:
           $ref: '#/components/schemas/authorName'
         description:
-          description: A description of the author. Will be null if there is none.
-          type: string
-          nullable: true
-          example: |
-            Terry Goodkind is a #1 New York Times Bestselling Author and creator of the critically acclaimed masterwork,
-            ‘The Sword of Truth’. He has written 30+ major, bestselling novels, has been published in more than 20
-            languages world-wide, and has sold more than 26 Million books. ‘The Sword of Truth’ is a revered literary
-            tour de force, comprised of 17 volumes, borne from over 25 years of dedicated writing. Terry Goodkind's
-            brilliant books are character-driven stories, with a focus on the complexity of the human psyche. Goodkind
-            has an uncanny grasp for crafting compelling stories about people like you and me, trapped in terrifying
-            situations.
+          $ref: '#/components/schemas/authorDescription'
         imagePath:
-          description: The absolute path for the author image located in the `metadata/` directory. Will be null if there is no image.
-          type: string
-          nullable: true
-          example: /metadata/authors/aut_bxxbyjiptmgb56yzoz.jpg
+          $ref: '#/components/schemas/authorImagePath'
         addedAt:
           $ref: '../../schemas.yaml#/components/schemas/addedAt'
         updatedAt:
           $ref: '../../schemas.yaml#/components/schemas/updatedAt'
-    authorWithItems:
-      type: object
-      description: The author schema with an array of items they are associated with.
-      allOf:
-        - $ref: '#/components/schemas/author'
-        - type: object
-          properties:
-            libraryItems:
-              description: The items associated with the author
-              type: string
-              type: array
-              items:
-                $ref: '../LibraryItem.yaml#/components/schemas/libraryItemMinified'
-    authorWithSeries:
-      type: object
-      description: The author schema with an array of items and series they are associated with.
-      allOf:
-        - $ref: '#/components/schemas/authorWithItems'
-        - type: object
-          properties:
-            series:
-              description: The series associated with the author
-              type: array
-              items:
-                $ref: '#/components/schemas/authorSeries'
+        libraryItems:
+          description: The items associated with the author
+          type: array
+          items:
+            $ref: '../LibraryItem.yaml#/components/schemas/libraryItemMinified'
+        series:
+          description: The series associated with the author
+          type: array
+          items:
+            $ref: '#/components/schemas/authorSeries'
     authorMinified:
       type: object
       description: Minified author object which only contains the author name and ID.
@@ -101,4 +83,4 @@ components:
             numBooks:
               description: The number of books associated with the author in the library.
               type: integer
-              example: 1
+              example: 1

docs/objects/entities/Series.yaml

@@ -8,4 +8,110 @@ components:
     seriesName:
       description: The name of the series.
       type: string
-      example: Sword of Truth
+      example: Sword of Truth
+    seriesDescription:
+      description: A description for the series. Will be null if there is none.
+      type: string
+      nullable: true
+      example: The Sword of Truth is a series of twenty one epic fantasy novels written by Terry Goodkind.
+    sequence:
+      description: The position in the series the book is.
+      type: string
+      nullable: true
+    seriesProgress:
+      type: object
+      description: The user's progress of a series.
+      properties:
+        libraryItemIds:
+          description: The IDs of the library items in the series.
+          type: array
+          items:
+            $ref: '../LibraryItem.yaml#/components/schemas/libraryItemId'
+        libraryItemIdsFinished:
+          description: The IDs of the library items in the series that are finished.
+          type: array
+          items:
+            $ref: '../LibraryItem.yaml#/components/schemas/libraryItemId'
+        isFinished:
+          description: Whether the series is finished.
+          type: boolean
+    series:
+      type: object
+      description: A series object which includes the name and description of the series.
+      properties:
+        id:
+          $ref: '#/components/schemas/seriesId'
+        name:
+          $ref: '#/components/schemas/seriesName'
+        description:
+          $ref: '#/components/schemas/seriesDescription'
+        addedAt:
+          $ref: '../../schemas.yaml#/components/schemas/addedAt'
+        updatedAt:
+          $ref: '../../schemas.yaml#/components/schemas/updatedAt'
+    seriesNumBooks:
+      type: object
+      description: A series object which includes the name and number of books in the series.
+      properties:
+        id:
+          $ref: '#/components/schemas/seriesId'
+        name:
+          $ref: '#/components/schemas/seriesName'
+        numBooks:
+          description: The number of books in the series.
+          type: integer
+        libraryItemIds:
+          description: The IDs of the library items in the series.
+          type: array
+          items:
+            $ref: '../LibraryItem.yaml#/components/schemas/libraryItemId'
+    seriesBooks:
+      type: object
+      description: A series object which includes the name and books in the series.
+      properties:
+        id:
+          $ref: '#/components/schemas/seriesId'
+        name:
+          $ref: '#/components/schemas/seriesName'
+        addedAt:
+          $ref: '../../schemas.yaml#/components/schemas/addedAt'
+        nameIgnorePrefix:
+          description: The name of the series with any prefix moved to the end.
+          type: string
+        nameIgnorePrefixSort:
+          description: The name of the series with any prefix removed.
+          type: string
+        type:
+          description: Will always be `series`.
+          type: string
+        books:
+          description: The library items that contain the books in the series. A sequence attribute that denotes the position in the series the book is in, is tacked on.
+          type: array
+          items:
+            $ref: '../LibraryItem.yaml#/components/schemas/libraryItemSequence'
+        totalDuration:
+          description: The combined duration (in seconds) of all books in the series.
+          type: number
+    seriesSequence:
+      type: object
+      description: A series object which includes the name and sequence of the series.
+      properties:
+        id:
+          $ref: '#/components/schemas/seriesId'
+        name:
+          $ref: '#/components/schemas/seriesName'
+        sequence:
+          $ref: '#/components/schemas/sequence'
+    seriesWithProgressAndRSS:
+      type: object
+      description: A series object which includes the name and progress of the series.
+      oneOf:
+        - $ref: '#/components/schemas/series'
+        - type: object
+          properties:
+            progress:
+              $ref: '#/components/schemas/seriesProgress'
+            rssFeed:
+              description: The RSS feed for the series.
+              type: string
+              example: 'TBD'

docs/objects/files/AudioFile.yaml

@@ -52,7 +52,7 @@ components:
           type: string
           example: MP2/3 (MPEG audio layer 2/3)
         duration:
-          $ref: '#/components/schemas/durationSec'
+          $ref: '../../schemas.yaml#/components/schemas/durationSec'
         bitRate:
           description: The bit rate (in bit/s) of the audio file.
           type: integer

docs/objects/files/EBookFile.yaml

@@ -0,0 +1,17 @@
+components:
+  schemas:
+    ebookFile:
+      type: object
+      properties:
+        ino:
+          $ref: '../../schemas.yaml#/components/schemas/inode'
+        metadata:
+          $ref: '../metadata/FileMetadata.yaml#/components/schemas/fileMetadata'
+        ebookFormat:
+          description: The ebook format of the ebook file.
+          type: string
+          example: epub
+        addedAt:
+          $ref: '../../schemas.yaml#/components/schemas/addedAt'
+        updatedAt:
+          $ref: '../../schemas.yaml#/components/schemas/updatedAt'

docs/objects/mediaTypes/Book.yaml

@@ -18,18 +18,18 @@ components:
         audioFiles:
           type: array
           items:
-            $ref: '#/components/schemas/audioFile'
+            $ref: '../files/AudioFile.yaml#/components/schemas/audioFile'
         chapters:
           type: array
           items:
-            $ref: '#/components/schemas/bookChapter'
+            $ref: '../metadata/BookMetadata.yaml#/components/schemas/bookChapter'
         missingParts:
           description: Any parts missing from the book by track index.
           type: array
           items:
             type: integer
         ebookFile:
-          $ref: '#/components/schemas/ebookFile'
+          $ref: '../files/EBookFile.yaml#/components/schemas/ebookFile'
     bookMinified:
       type: object
       description: Minified book schema. Does not depend on `bookBase` because there's pretty much no overlap.

docs/root.yaml

@@ -7,151 +7,40 @@ servers:
   - url: http://localhost:3000
     description: Development server
 components:
-    securitySchemes:
-        BearerAuth:
-            type: http
-            scheme: bearer
-    responses:
-        ok200:
-            description: OK
+  securitySchemes:
+    BearerAuth:
+      description: Bearer authentication
+      type: http
+      scheme: bearer
 security:
-    - BearerAuth: []
+  - BearerAuth: []
 paths:
   /api/authors/{id}:
-    get:
-      operationId: getAuthorById
-      summary: Get a single author by ID on server
-      tags:
-        - Authors
-      parameters:
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/authorId'
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/authorInclude'
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/authorLibraryId'
-      responses:
-        200:
-          description: getAuthorById OK
-          content:
-            application/json:
-              schema:
-                oneOf:
-                  - $ref: './objects/entities/Author.yaml#/components/schemas/author'
-                  - $ref: './objects/entities/Author.yaml#/components/schemas/authorWithItems'
-                  - $ref: './objects/entities/Author.yaml#/components/schemas/authorWithSeries'
-        404:
-          $ref: './controllers/AuthorController.yaml#/components/responses/author404'
-    patch:
-      operationId: updateAuthorById
-      summary: Update a single author by ID on server. This endpoint will merge two authors if the new author name matches another author in the database.
-      tags:
-        - Authors
-      parameters:
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/authorId'
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/asin'
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/authorName'
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/authorDescription'
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/authorImagePath'
-      responses:
-        200:
-          description: updateAuthorById OK
-          content:
-            application/json:
-              schema:
-                allOf:
-                  - $ref: './objects/entities/Author.yaml#/components/schemas/author'
-                  - $ref: './controllers/AuthorController.yaml#/components/schemas/authorUpdated'
-                  - type: object
-                    properties:
-                      merged:
-                        description: Will only exist and be `true` if the author was merged with another author
-                        type: boolean
-                        nullable: true
-        404:
-          $ref: './controllers/AuthorController.yaml#/components/responses/author404'
-    delete:
-      operationId: deleteAuthorById
-      summary: Delete a single author by ID on server and remove author from all books.
-      tags:
-        - Authors
-      parameters:
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/authorId'
-      responses:
-        200:
-          $ref: '#/components/responses/ok200'
-        404:
-          $ref: './controllers/AuthorController.yaml#/components/responses/author404'
+    $ref: './controllers/AuthorController.yaml#/paths/~1api~1authors~1{id}'
   /api/authors/{id}/image:
-    post:
-      operationId: setAuthorImageById
-      summary: Set an author image using a provided URL.
-      tags:
-        - Authors
-      parameters:
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/authorId'
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/imageUrl'
-      responses:
-        200:
-          description: setAuthorImageById OK
-          content:
-            application/json:
-              schema:
-                oneOf:
-                  - $ref: './objects/entities/Author.yaml#/components/schemas/author'
-        404:
-          $ref: './controllers/AuthorController.yaml#/components/responses/author404'
-    delete:
-      operationId: deleteAuthorImageById
-      summary: Delete an author image from the server and remove the image from the database.
-      tags:
-        - Authors
-      parameters:
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/authorId'
-      responses:
-        200:
-          $ref: '#/components/responses/ok200'
-        404:
-          $ref: './controllers/AuthorController.yaml#/components/responses/author404'
-    patch:
-      operationId: getAuthorImageById
-      summary: Return the author image by author ID.
-      tags:
-        - Authors
-      parameters:
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/authorId'
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/imageWidth'
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/imageHeight'
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/imageFormat'
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/imageRaw'
-      responses:
-        200:
-          description: getAuthorImageById OK
-          content:
-            image/*:
-              schema:
-                type: string
-                format: binary
-        404:
-          $ref: './controllers/AuthorController.yaml#/components/responses/author404'
+    $ref: './controllers/AuthorController.yaml#/paths/~1api~1authors~1{id}~1image'
   /api/authors/{id}/match:
-    post:
-      operationId: matchAuthorById
-      summary: Match the author against Audible using quick match. Quick match updates the author's description and image (if no image already existed) with information from audible. Either `asin` or `q` must be provided, with `asin` taking priority if both are provided.
-      tags:
-        - Authors
-      parameters:
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/authorId'
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/asin'
-        - $ref: './controllers/AuthorController.yaml#/components/parameters/authorSearchName'
-      responses:
-        200:
-          description: matchAuthorById OK
-          content:
-            application/json:
-              schema:
-                allOf:
-                  - $ref: './objects/entities/Author.yaml#/components/schemas/author'
-                  - $ref: './controllers/AuthorController.yaml#/components/schemas/authorUpdated'
-        404:
-          $ref: './controllers/AuthorController.yaml#/components/responses/author404'
+    $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/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

docs/schemas.yaml

@@ -25,9 +25,38 @@ components:
       type: array
       items:
         type: string
-      example: ["To Be Read", "Genre: Nonfiction"]
+      example: ['To Be Read', 'Genre: Nonfiction']
     inode:
       description: The inode of the item in the file system.
       type: string
-      format: "[0-9]*"
-      example: '649644248522215260'
+      format: '[0-9]*'
+      example: '649644248522215260'
+    total:
+      description: The total number of items in the response.
+      type: integer
+      example: 100
+    limit:
+      description: The number of items to return. If 0, no items are returned.
+      type: integer
+      example: 10
+      default: 0
+    page:
+      description: The page number (zero indexed) to return. If no limit is specified, then page will have no effect.
+      type: integer
+      example: 1
+      default: 0
+    sortDesc:
+      description: Return items in reversed order if true.
+      type: boolean
+      example: true
+      default: false
+    minified:
+      description: Return minified items if true.
+      type: boolean
+      example: true
+      default: false
+    region:
+      description: The region used to search.
+      type: string
+      example: 'us'
+      default: 'us'