Kavita

Kavita Settings API

The Settings API from Kavita — 18 operation(s) for settings.

GitHub OpenAPI

Operations 20

GET /api/Settings/base-url Returns the base url for this instance (if set) #
GET /api/Settings Returns the server settings #
POST /api/Settings Update Server settings #
POST /api/Settings/reset Create api settings reset #
POST /api/Settings/reset-ip-addresses Resets the IP Addresses #
POST /api/Settings/reset-base-url Resets the Base url #
GET /api/Settings/is-email-setup Is the minimum information setup for Email to work #
GET /api/Settings/task-frequencies All values allowed for Task Scheduling APIs. A custom cron job is not included. #
GET /api/Settings/library-types Get api settings library types #
GET /api/Settings/log-levels Get api settings log levels #
GET /api/Settings/opds-enabled Get api settings opds enabled #
GET /api/Settings/is-valid-cron Is the cron expression valid for Kavita's scheduler #
POST /api/Settings/test-email-url Sends a test email to see if email settings are hooked up correctly #
GET /api/Settings/metadata-settings Get the metadata settings for Kavita+ users #
POST /api/Settings/metadata-settings Update the metadata settings for Kavita+ Metadata feature #
POST /api/Settings/run-metadata-mappings Create api settings run metadata mappings #
POST /api/Settings/import-field-mappings Import field mappings #
GET /api/Settings/oidc Retrieve publicly required configuration regarding Oidc #
POST /api/Settings/reset-external-ids Create api settings reset external ids #
POST /api/Settings/is-valid-authority Validate if the given authority is reachable from the server #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/kavita/openapi/kavita-settings-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/kavita:kavita-settings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

kavita-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Kavita Settings API
  description: Kavita provides a set of APIs authenticated via an Auth Key passed in the `x-api-key` header. Generate an Auth Key under User Settings → Manage Auth Keys, paste it into the Authorize panel, and all Try It requests will include it. Assume all fields of a payload are required unless marked optional. Built against v0.9.1.15
  license:
    name: GPL-3.0
    url: https://github.com/Kareadita/Kavita/blob/develop/LICENSE
  version: 0.9.1.15
servers:
- url: '{protocol}://{hostpath}'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    hostpath:
      default: localhost:5000
security:
- AuthKey: []
tags:
- name: Settings
paths:
  /api/Settings/base-url:
    get:
      tags:
      - Settings
      summary: Returns the base url for this instance (if set)
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      operationId: getApiSettingsBaseUrl
      x-operation-id-source: derived
  /api/Settings:
    get:
      tags:
      - Settings
      summary: Returns the server settings
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
            application/json:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
            text/json:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
      operationId: getApiSettings
      x-operation-id-source: derived
    post:
      tags:
      - Settings
      summary: Update Server settings
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServerSettingDto'
          text/json:
            schema:
              $ref: '#/components/schemas/ServerSettingDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ServerSettingDto'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
            application/json:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
            text/json:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
      operationId: postApiSettings
      x-operation-id-source: derived
  /api/Settings/reset:
    post:
      tags:
      - Settings
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
            application/json:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
            text/json:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
      summary: Create api settings reset
      x-summary-source: derived
      operationId: postApiSettingsReset
      x-operation-id-source: derived
  /api/Settings/reset-ip-addresses:
    post:
      tags:
      - Settings
      summary: Resets the IP Addresses
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
            application/json:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
            text/json:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
      operationId: postApiSettingsResetIpAddresses
      x-operation-id-source: derived
  /api/Settings/reset-base-url:
    post:
      tags:
      - Settings
      summary: Resets the Base url
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
            application/json:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
            text/json:
              schema:
                $ref: '#/components/schemas/ServerSettingDto'
      operationId: postApiSettingsResetBaseUrl
      x-operation-id-source: derived
  /api/Settings/is-email-setup:
    get:
      tags:
      - Settings
      summary: Is the minimum information setup for Email to work
      parameters:
      - name: forDevice
        in: query
        description: Device send-to doesn't need full email setup (hostname)
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: boolean
            application/json:
              schema:
                type: boolean
            text/json:
              schema:
                type: boolean
      operationId: getApiSettingsIsEmailSetup
      x-operation-id-source: derived
  /api/Settings/task-frequencies:
    get:
      tags:
      - Settings
      summary: All values allowed for Task Scheduling APIs. A custom cron job is not included.
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  type: string
            application/json:
              schema:
                type: array
                items:
                  type: string
            text/json:
              schema:
                type: array
                items:
                  type: string
      operationId: getApiSettingsTaskFrequencies
      x-operation-id-source: derived
  /api/Settings/library-types:
    get:
      tags:
      - Settings
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  type: string
            application/json:
              schema:
                type: array
                items:
                  type: string
            text/json:
              schema:
                type: array
                items:
                  type: string
      summary: Get api settings library types
      x-summary-source: derived
      operationId: getApiSettingsLibraryTypes
      x-operation-id-source: derived
  /api/Settings/log-levels:
    get:
      tags:
      - Settings
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  type: string
            application/json:
              schema:
                type: array
                items:
                  type: string
            text/json:
              schema:
                type: array
                items:
                  type: string
      summary: Get api settings log levels
      x-summary-source: derived
      operationId: getApiSettingsLogLevels
      x-operation-id-source: derived
  /api/Settings/opds-enabled:
    get:
      tags:
      - Settings
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: boolean
            application/json:
              schema:
                type: boolean
            text/json:
              schema:
                type: boolean
      summary: Get api settings opds enabled
      x-summary-source: derived
      operationId: getApiSettingsOpdsEnabled
      x-operation-id-source: derived
  /api/Settings/is-valid-cron:
    get:
      tags:
      - Settings
      summary: Is the cron expression valid for Kavita's scheduler
      parameters:
      - name: cronExpression
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: boolean
            application/json:
              schema:
                type: boolean
            text/json:
              schema:
                type: boolean
      operationId: getApiSettingsIsValidCron
      x-operation-id-source: derived
  /api/Settings/test-email-url:
    post:
      tags:
      - Settings
      summary: Sends a test email to see if email settings are hooked up correctly
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/EmailTestResultDto'
            application/json:
              schema:
                $ref: '#/components/schemas/EmailTestResultDto'
            text/json:
              schema:
                $ref: '#/components/schemas/EmailTestResultDto'
      operationId: postApiSettingsTestEmailUrl
      x-operation-id-source: derived
  /api/Settings/metadata-settings:
    get:
      tags:
      - Settings
      summary: Get the metadata settings for Kavita+ users
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/MetadataSettingsDto'
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataSettingsDto'
            text/json:
              schema:
                $ref: '#/components/schemas/MetadataSettingsDto'
      operationId: getApiSettingsMetadataSettings
      x-operation-id-source: derived
    post:
      tags:
      - Settings
      summary: Update the metadata settings for Kavita+ Metadata feature
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetadataSettingsDto'
          text/json:
            schema:
              $ref: '#/components/schemas/MetadataSettingsDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/MetadataSettingsDto'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/MetadataSettingsDto'
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataSettingsDto'
            text/json:
              schema:
                $ref: '#/components/schemas/MetadataSettingsDto'
      operationId: postApiSettingsMetadataSettings
      x-operation-id-source: derived
  /api/Settings/run-metadata-mappings:
    post:
      tags:
      - Settings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunMetadataMappingsRequestDto'
          text/json:
            schema:
              $ref: '#/components/schemas/RunMetadataMappingsRequestDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/RunMetadataMappingsRequestDto'
      responses:
        '200':
          description: OK
      summary: Create api settings run metadata mappings
      x-summary-source: derived
      operationId: postApiSettingsRunMetadataMappings
      x-operation-id-source: derived
  /api/Settings/import-field-mappings:
    post:
      tags:
      - Settings
      summary: Import field mappings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportFieldMappingsDto'
          text/json:
            schema:
              $ref: '#/components/schemas/ImportFieldMappingsDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ImportFieldMappingsDto'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/FieldMappingsImportResultDto'
            application/json:
              schema:
                $ref: '#/components/schemas/FieldMappingsImportResultDto'
            text/json:
              schema:
                $ref: '#/components/schemas/FieldMappingsImportResultDto'
      operationId: postApiSettingsImportFieldMappings
      x-operation-id-source: derived
  /api/Settings/oidc:
    get:
      tags:
      - Settings
      summary: Retrieve publicly required configuration regarding Oidc
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OidcPublicConfigDto'
            application/json:
              schema:
                $ref: '#/components/schemas/OidcPublicConfigDto'
            text/json:
              schema:
                $ref: '#/components/schemas/OidcPublicConfigDto'
      operationId: getApiSettingsOidc
      x-operation-id-source: derived
  /api/Settings/reset-external-ids:
    post:
      tags:
      - Settings
      responses:
        '200':
          description: OK
      summary: Create api settings reset external ids
      x-summary-source: derived
      operationId: postApiSettingsResetExternalIds
      x-operation-id-source: derived
  /api/Settings/is-valid-authority:
    post:
      tags:
      - Settings
      summary: Validate if the given authority is reachable from the server
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthorityValidationDto'
          text/json:
            schema:
              $ref: '#/components/schemas/AuthorityValidationDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AuthorityValidationDto'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AuthorityValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorityValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/AuthorityValidationResult'
      operationId: postApiSettingsIsValidAuthority
      x-operation-id-source: derived
components:
  schemas:
    OidcConfigDto:
      type: object
      properties:
        autoLogin:
          type: boolean
        disablePasswordAuthentication:
          type: boolean
        providerName:
          type:
          - string
          - 'null'
        authority:
          type:
          - string
          - 'null'
        clientId:
          type:
          - string
          - 'null'
        secret:
          type:
          - string
          - 'null'
        provisionAccounts:
          type: boolean
        requireVerifiedEmail:
          type: boolean
        syncUserSettings:
          type: boolean
        rolesPrefix:
          type:
          - string
          - 'null'
        rolesClaim:
          type:
          - string
          - 'null'
        customScopes:
          type:
          - array
          - 'null'
          items:
            type: string
        defaultRoles:
          type:
          - array
          - 'null'
          items:
            type: string
        defaultLibraries:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        defaultAgeRestriction:
          $ref: '#/components/schemas/AgeRating'
        defaultIncludeUnknowns:
          type: boolean
        enabled:
          type: boolean
          readOnly: true
      additionalProperties: false
    AuthorityValidationDto:
      type: object
      properties:
        authority:
          type:
          - string
          - 'null'
      additionalProperties: false
    ServerSettingDto:
      type: object
      properties:
        cacheDirectory:
          type:
          - string
          - 'null'
        taskScan:
          type:
          - string
          - 'null'
        taskBackup:
          type:
          - string
          - 'null'
        taskCleanup:
          type:
          - string
          - 'null'
        taskCblSync:
          type:
          - string
          - 'null'
        loggingLevel:
          type:
          - string
          - 'null'
        port:
          type: integer
          format: int32
        ipAddresses:
          type:
          - string
          - 'null'
        allowStatCollection:
          type: boolean
        enableOpds:
          type: boolean
        baseUrl:
          type:
          - string
          - 'null'
        bookmarksDirectory:
          type:
          - string
          - 'null'
        installVersion:
          type:
          - string
          - 'null'
        installId:
          type:
          - string
          - 'null'
        encodeMediaAs:
          $ref: '#/components/schemas/EncodeFormat'
        totalBackups:
          type: integer
          format: int32
        enableFolderWatching:
          type: boolean
        totalLogs:
          type: integer
          format: int32
        hostName:
          type:
          - string
          - 'null'
        cacheSize:
          type: integer
          format: int64
        onDeckProgressDays:
          type: integer
          format: int32
        onDeckUpdateDays:
          type: integer
          format: int32
        coverImageSize:
          $ref: '#/components/schemas/CoverImageSize'
        pdfRenderResolution:
          $ref: '#/components/schemas/PdfRenderResolution'
        smtpConfig:
          $ref: '#/components/schemas/SmtpConfigDto'
        oidcConfig:
          $ref: '#/components/schemas/OidcConfigDto'
        firstInstallDate:
          type:
          - string
          - 'null'
          format: date-time
        firstInstallVersion:
          type:
          - string
          - 'null'
        statsApiHits:
          type: integer
          format: int32
      additionalProperties: false
    MetadataSettingField:
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 40
      type: integer
      description: 'Members:

        - `1` — Summary

        - `2` — PublicationStatus

        - `3` — StartDate

        - `4` — Genres

        - `5` — Tags

        - `6` — LocalizedName

        - `7` — Covers

        - `8` — AgeRating

        - `9` — People

        - `10` — Name

        - `11` — SortName

        - `20` — ChapterTitle

        - `21` — ChapterSummary

        - `22` — ChapterReleaseDate

        - `23` — ChapterPublisher

        - `24` — ChapterCovers

        - `25` — ChapterAgeRating

        - `40` — VolumeCovers'
      format: int32
      x-enum-varnames:
      - Summary
      - PublicationStatus
      - StartDate
      - Genres
      - Tags
      - LocalizedName
      - Covers
      - AgeRating
      - People
      - Name
      - SortName
      - ChapterTitle
      - ChapterSummary
      - ChapterReleaseDate
      - ChapterPublisher
      - ChapterCovers
      - ChapterAgeRating
      - VolumeCovers
      x-enum-descriptions:
      - Summary
      - PublicationStatus
      - StartDate
      - Genres
      - Tags
      - LocalizedName
      - Covers
      - AgeRating
      - People
      - Name
      - SortName
      - ChapterTitle
      - ChapterSummary
      - ChapterReleaseDate
      - ChapterPublisher
      - ChapterCovers
      - ChapterAgeRating
      - VolumeCovers
    TagWeight:
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
      description: 'Members:

        - `1` — Core

        - `2` — Defining

        - `3` — Recurrent

        - `4` — Incidental

        - `5` — Unweighted'
      format: int32
      x-enum-varnames:
      - Core
      - Defining
      - Recurrent
      - Incidental
      - Unweighted
      x-enum-descriptions:
      - Core
      - Defining
      - Recurrent
      - Incidental
      - Unweighted
    SeriesNameLanguageDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        localizedName:
          type:
          - string
          - 'null'
      additionalProperties: false
    AgeRating:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - -1
      type: integer
      description: 'Members:

        - `0` — Unknown

        - `1` — Rating Pending (RatingPending)

        - `2` — Early Childhood (EarlyChildhood)

        - `3` — Everyone

        - `4` — G

        - `5` — Everyone 10+ (Everyone10Plus)

        - `6` — PG

        - `7` — Kids to Adults (KidsToAdults)

        - `8` — Teen

        - `9` — MA15+ (Mature15Plus)

        - `10` — Mature 17+ (Mature17Plus)

        - `11` — M (Mature)

        - `12` — R18+ (R18Plus)

        - `13` — Adults Only 18+ (AdultsOnly)

        - `14` — X18+ (X18Plus)

        - `-1` — Not Applicable (NotApplicable)'
      format: int32
      x-enum-varnames:
      - Unknown
      - RatingPending
      - EarlyChildhood
      - Everyone
      - G
      - Everyone10Plus
      - PG
      - KidsToAdults
      - Teen
      - Mature15Plus
      - Mature17Plus
      - Mature
      - R18Plus
      - AdultsOnly
      - X18Plus
      - NotApplicable
      x-enum-descriptions:
      - Unknown
      - Rating Pending
      - Early Childhood
      - Everyone
      - G
      - Everyone 10+
      - PG
      - Kids to Adults
      - Teen
      - MA15+
      - Mature 17+
      - M
      - R18+
      - Adults Only 18+
      - X18+
      - Not Applicable
    SmtpConfigDto:
      type: object
      properties:
        senderAddress:
          type:
          - string
          - 'null'
        senderDisplayName:
          type:
          - string
          - 'null'
        userName:
          type:
          - string
          - 'null'
        password:
          type:
          - string
          - 'null'
        host:
          type:
          - string
          - 'null'
        port:
          type: integer
          format: int32
        enableSsl:
          type: boolean
        sizeLimit:
          type: integer
          format: int32
        customizedTemplates:
          type: boolean
      additionalProperties: false
    ImportFieldMappingsDto:
      type: object
      properties:
        settings:
          $ref: '#/components/schemas/ImportSettingsDto'
        data:
          $ref: '#/components/schemas/FieldMappingsDto'
      additionalProperties: false
    RunMetadataMappingsRequestDto:
      type: object
      properties:
        allLibraries:
          type: boolean
        includedLibraries:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        excludedLibraries:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
      additionalProperties: false
    MetadataFieldMappingDto:
      type: object
      properties:
        id:
          type: integer
          format: int32
        sourceType:
          $ref: '#/components/schemas/MetadataFieldType'
        destinationType:
          $ref: '#/components/schemas/MetadataFieldType'
        sourceValue:
          type:
          - string
          - 'null'
        destinationValue:
          type:
          - string
          - 'null'
        excludeFromSource:
          type: boolean
      additionalProperties: false
    ConflictResolution:
      enum:
      - 0
      - 1
      - 2
      type: integer
      description: 'Members:

        - `0` — Manual

        - `1` — Keep

        - `2` — Replace'
      format: int32
      x-enum-varnames:
      - Manual
      - Keep
      - Replace
      x-enum-descriptions:
      - Manual
      - Keep
      - Replace
    FieldMappingsDto:
      type: object
      properties:
        blacklist:
          type:
          - array
          - 'null'
          items:
            type: string
        whitelist:
          type:
          - array
          - 'null'
          items:
            type: string
        ageRatingMappings:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/AgeRating'
        fieldMappings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MetadataFieldMappingDto'
      additionalProperties: false
    EmailTestResultDto:
      type: object
      properties:
        successful:
          type: boolean
        errorMessage:
          type:
          - string
          - 'null'
        emailAddress:
          type:
          - string
          - 'null'
      additionalProperties: false
    AuthorityValidationResult:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      type: integer
      description: 'Members:

        - `0` — Success

        - `1` — InvalidAuthority

        - `2` — Failure

        - `3` — NotApplicable

        - `4` — MissingHttps'
      format: int32
      x-enum-varnames:
      - Success
      - InvalidAuthority
      - Failure
      - NotApplicable
      - MissingHttps
      x-enum-descriptions:
      - Success
      - InvalidAuthority
      - Failure
      - NotApplicable
      - MissingHttps
    FieldMappingsImportResultDto:
      type: object
      properties:
        success:
          type: boolean
        resultingMetadataSettings:
          $ref: '#/components/schemas/MetadataSettingsDto'
        ageRatingConflicts:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    ImportMode:
      enum:
      - 0
      - 1
      type: integer
      description: 'Members:

        - `0` — Replace

        - `1` — Merge'
      format: int32
      x-enum-varnames:
      - Replace
      - Merge
      x-enum-descriptions:
      - Replace
      - Merge
    ImportSettingsDto:
      type: object
      properties:
        importMode:
          $ref: '#/components/schemas/ImportMode'
        resolution:
          $ref: '#/components/schemas/ConflictResolution'
        whitelist:
          type: boolean
        blacklist:
          type: boolean
        ageRatings:
          type: boolean
        fieldMappings:
          type: boolean
        ageRatingConflictResolutions:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/ConflictResolution'
      additionalProperties: false
    PersonRole:
      enum:
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      type: integer
      description: 'Members:

        - `3` — Writer

        - `4` — Penciller

        - `5` — Inker

        - `6` — Colorist

        - `7` — Letterer

        - `8` — CoverArtist

        - `9` — Editor

        - `10` — Publisher

        - `11` — Character

        - `12` — Translator

        - `13` — Imprint

        - `14` — Team

        - `15` — Location'
      format: int32
      x-enum-varnames:
      - Writer
      - Penciller
      - Inker
      - Colorist
      - Letterer
      - CoverArtist
      - Editor
      - Publisher
      - Character
      - Translator
      - Imprint
      - Team
      - Location
      x-enum-descriptions:
      - Writer
      - Penciller
      - Inker
      - Colorist
      - Letterer
      - CoverArtist
      - Editor
      - Publisher
      - Character
      - Translator
      - Imprint
      - Team
      - Location
    MetadataFieldType:
      enum:
      - 0
      - 1
      type: integer
      description: 'Members:

        - `0` — Genre

        - `1` — Tag'
      format: int32
      x-enum-varnames:
      - Genre
      - Tag
      x-enum-descriptions:
      - Genre
      - Tag
    CoverImageSize:
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
      description: 'Members:

        - `1` — Default

        - `2` — Medium

        - `3` — Large

        - `4` — XLarge'
      format: int32
      x-enum-varnames:
      - Default
      - Medium
      - Large
      - XLarge
      x-enum-descriptions:
      - Default
      - Medium
      - Large
      - XLarge
    EncodeFormat:
      enum:
      - 0
      - 1
      - 2
      type: integer
      description: 'Members:

        - `0` — PNG

        - `1` — WebP (WEBP)

        - `2` — AVIF'
      format: int32
      x-enum-varnames:
      - PNG
      - WEBP
      - AVIF
      x-enum-descriptions:
      - PNG
      - WebP
      - AVIF
    MetadataSettingsDto:
      type: object
      properties:
        blacklist:
          type:
          - array
          - 'null'
          items:
            type: string
        whitelist:
          type:
          - array
          - 'null'
          items:
            type: string
        ageRatingMappings:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/AgeRating'
        fieldMappings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MetadataFieldMappingDto'
        enabled:
          type: boolean
        enableExtendedMetadataProcessing:
          type: boolean
        enableSummary:
          type: boolean
        enablePublicationStatus:
          type: boolean
        enableAgeRating:
          type: boolean
        enableRelationships:
          type: boolean
        enablePeople:
          type: boolean
        enableStartDate:
          type: boolean
        enableLocalizedName:
          type: boolean
        enableName:
          type: boolean
        enableCoverImage:
          type: boolean
        enableChapterSummary:
          type: boolean
        enableChapterReleaseDate:
          type: boolean
        enableChapterTitle:
          type: boolean
        enableChapterPublisher:
          type: boolean
        enableChapterCoverImage:
          type: boolean
        enableVolumeCoverImage:
          type: boolean
        enableGenres:
          type: boolean
        enableTags:
          type: boolean
        firstLastPeopleNaming:
          type: boolean
        externalAgeRatingMappings:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/AgeRating'
        globalLanguageTitleSettings:
          $ref: '#/components/schemas/SeriesNameLanguageDto'
        libraryLanguageTitleOverrides:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SeriesNameLanguageDto'
        overrides:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MetadataSettingField'
        personRoles:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PersonRole'
        filterAboveWeight:
          $ref: '#/components/schemas/TagWeight'
      additionalProperties: false
    PdfRenderResolution:
      enum:
      - 1
      - 2
      - 3
      type: integer
      description: 'Members:

        - `1` — Default

        - `2` — High

        - `3` — Ultra'
      format: int32
      x-enum-varnames:
      - Default
      - High
      - Ultra
      x-enum-descriptions:
      - Default
      - High
      - Ultra
    OidcPublicConfigDto:
      type: object
      properties:
        autoLogin:
          type: boolean
        disablePasswordAuthentication:
          type: boolean
        providerName:
          type:
          - string
          - 'null'
        enabled:
          type: boolean
      additionalProperties: false
  securitySchemes:
    AuthKey:
      type: apiKey
      description: Auth Key authentication. Enter your Auth key from your user settings
      name: x-api-key
      in: header