Settings

Update the metadata settings for Kavita+ Metadata feature

Changed on
post/api/Settings/metadata-settings

Request

  • Base URL
    http://localhost:5000
  • URL
    http://localhost:5000/api/Settings/metadata-settings
  • Auth
    API key in header x-api-key

Request body

blackliststring[] nullable
whiteliststring[] nullable
ageRatingMappingsobject nullable
enabledboolean
enableExtendedMetadataProcessingboolean
enableSummaryboolean
enablePublicationStatusboolean
enableAgeRatingboolean
enableRelationshipsboolean
enablePeopleboolean
enableStartDateboolean
enableLocalizedNameboolean
enableNameboolean
enableCoverImageboolean
enableChapterSummaryboolean
enableChapterReleaseDateboolean
enableChapterTitleboolean
enableChapterPublisherboolean
enableChapterCoverImageboolean
enableVolumeCoverImageboolean
enableGenresboolean
enableTagsboolean
firstLastPeopleNamingboolean
externalAgeRatingMappingsobject nullable
libraryLanguageTitleOverridesobject nullable
overridesMetadataSettingField[] nullable
personRolesPersonRole[] nullable
filterAboveWeight1 | 2 | 3 | 4 | 5

Members:

  • 1 — Core
  • 2 — Defining
  • 3 — Recurrent
  • 4 — Incidental
  • 5 — Unweighted

Response

OK

blackliststring[] nullable
whiteliststring[] nullable
ageRatingMappingsobject nullable
enabledboolean
enableExtendedMetadataProcessingboolean
enableSummaryboolean
enablePublicationStatusboolean
enableAgeRatingboolean
enableRelationshipsboolean
enablePeopleboolean
enableStartDateboolean
enableLocalizedNameboolean
enableNameboolean
enableCoverImageboolean
enableChapterSummaryboolean
enableChapterReleaseDateboolean
enableChapterTitleboolean
enableChapterPublisherboolean
enableChapterCoverImageboolean
enableVolumeCoverImageboolean
enableGenresboolean
enableTagsboolean
firstLastPeopleNamingboolean
externalAgeRatingMappingsobject nullable
libraryLanguageTitleOverridesobject nullable
overridesMetadataSettingField[] nullable
personRolesPersonRole[] nullable
filterAboveWeight1 | 2 | 3 | 4 | 5

Members:

  • 1 — Core
  • 2 — Defining
  • 3 — Recurrent
  • 4 — Incidental
  • 5 — Unweighted

Changes

    • warning

      added the new 11.00 enum value to the / response property for the response status (media type: text/plain)

    • warning

      added the new 11.00 enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new 11.00 enum value to the / response property for the response status (media type: text/json)

    • info

      added the new 11.00 enum value to the request property / (media type: application/json)

    • info

      added the new 11.00 enum value to the request property / (media type: text/json)

    • info

      added the new 11.00 enum value to the request property / (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)