Danbooru
Login Posts Comments Notes Artists Tags Pools Wiki Forum More ยป
Search Changes Help | Posts (0) History
  • Help
guro
scat
furry -rating:g

Recent Changes (all)

  • ukinami yuzuha
  • alice thymefield
  • yamaguchi yuriko
  • drackyma
  • tundracky
  • drackolyte
  • drackmage
  • rhinedottir (genshin impact)
  • naberius (genshin impact)
  • ronova (genshin impact)
  • istaroth (genshin impact)
  • oshino ripia
  • unknown god (genshin impact)
  • slave visor (tsmg nao!)
  • labraunda (fire emblem)
  • karin (school uniform) (blue archive)
  • karin (blue archive)
  • skirk (genshin impact)
  • katsute mahou shoujo to aku wa tekitai shiteita
  • busamen gachi fighter
  • no sleep for kaname date - from ai: the somnium files
  • moona hoshinova
  • inui ichiko
  • no sleep for kaname date
  • edelgard von hresvelg (adrestian emperor)

Options

  • Wiki History
  • Discussions
  • What Links Here

api:artist commentaries

Table of Contents
  • 01. Record field format
  • 02. Associated attributes
  • 03. Nomenclature
  • 04. Index
  • 05. Show
  • 06. Create or update
  • 07. Revert
  • 08. See also

The following includes the details of how to interface with the artist commentary records through the API.

Record field format

NameTypeDetails
idinteger>0
post_idinteger>0
original_titlestring
original_descriptionstring
translated_titlestring
translated_descriptionstring
created_attimestamp
updated_attimestamp

Associated attributes

NameTypeNumberAvailabilityDetails
postpostsinglerequiredPost that the artist commentary belongs to.

Nomenclature

  • Plural form: "artist_commentaries"
    • Used in the URL pathname
  • Singular form: "artist_commentary"
    • Used for write parameters (Help:API Write Requests)
  • Versions: API:Artist commentary versions

Index

HTTP MethodGET
Base URL/artist_commentaries.json
Typeread request
DescriptionThe default order is ID descending.
Search attributes

All of the following are standard attributes with all of their available formats and qualifiers.

  • Number syntax
    • id
    • created_at
    • updated_at
  • Text syntax
    • original_title
    • original_description
    • translated_title
    • translated_description
  • Post syntax
    • post
Special search parameters
  • text_matches - Case-insensitive wildcard searching on any of the text fields.
  • original_present (boolean syntax) - Does it have an original title or an original description?
  • translated_present (boolean syntax) - Does it have a translated title or a translated description?
  • is_deleted (yes or no) - Does it have all empty fields or not?
Search order

The search order can only be changed with the custom parameter.

Show

HTTP MethodGET
Base URL/artist_commentaries/$id.json
/posts/$post_id/artist_commentary.json
Typeread request
Description$id is the artist commentary ID.
$post_id is ID of the post that the commentary belongs to.

Note: This does a redirect to the post with that commentary when using the HTML interface.

Create or Update

HTTP MethodPUT
Base URL/artist_commentaries/create_or_update.json
/posts/$post_id/artist_commentary/create_or_update.json
Typewrite request
Description$post_id is ID of the post that the commentary belongs to.
Create/update parameters
  • Required:
    • post_id - The post ID the commentary belongs to.
      • When using the /posts/$post_id/ version, the post ID is already set.
  • Optional
    • original_title
    • original_description
    • translated_title
    • translated_description
    • add_commentary_tag - Add the commentary tag.
    • add_commentary_request_tag - Add the commentary_request tag.
    • add_commentary_check_tag - Add the commentary_check tag.
    • add_partial_commentary_tag - Add the partial_commentary tag.
    • remove_commentary_tag - Remove the commentary tag.
    • remove_commentary_request_tag - Remove the commentary_request tag.
    • remove_commentary_check_tag - Remove the commentary_check tag.
    • remove_partial_commentary_tag - Remove the partial_commentary tag.

Revert

HTTP MethodPUT
Base URL/artist_commentaries/$id/revert.json
/posts/$post_id/artist_commentary/revert.json
Typewrite request
Description$id is the post ID (not the artist commentary ID).
$post_id is ID of the post that the commentary belongs to.
Revert parameters
  • Required:
    • version_id - The artist commentary version ID to revert to.

Note: The version ID may be passed along as a URL parameter instead of in the body.

See also

  • Help:Common URL Parameters
  • Help:API

External links

Controllerhttps://github.com/danbooru/danbooru/blob/master/app/controllers/artist_commentaries_controller.rb
Modelhttps://github.com/danbooru/danbooru/blob/master/app/models/artist_commentary.rb
Policyhttps://github.com/danbooru/danbooru/blob/master/app/policies/artist_commentary_policy.rb
Terms / Privacy / Upgrade / Contact /