[danbooru] extend 'metadata' option

make it possible to specify a custom list of metadata includes
2023-01-13 16:20:01 +01:00
parent 26c3292538
commit c87bd1a752
2 changed files with 26 additions and 10 deletions
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -1027,13 +1027,22 @@ Description
 extractor.danbooru.metadata
 ---------------------------
 Type
-    ``bool``
+    * ``bool``
+    * ``string``
+    * ``list`` of ``strings``
 Default
    ``false``
+Example
+    * ``replacements,comments,ai_tags``
+    * ``["replacements", "comments", "ai_tags"]``
 Description
    Extract additional metadata
    (notes, artist commentary, parent, children, uploader)

+    It is possible to specify a custom list of metadata includes.
+    See `available_includes <https://github.com/danbooru/danbooru/blob/2cf7baaf6c5003c1a174a8f2d53db010cf05dca7/app/models/post.rb#L1842-L1849>`__
+    for possible field names. ``aibooru`` also supports ``ai_metadata``.
+
    Note: This requires 1 additional HTTP request per post.