api:artist commentaries
The following includes the details of how to interface with the artist commentary records through the API.
Record field format
- id: integer, > 0
- post_id: integer, > 0
- original_title: string
- original_description: string
- translated_title: string
- translated_description: string
- created_at: timestamp
- updated_at: timestamp
Associated attributes
- post - The post that the commentary belongs to.
Endpoints
Endpoint refers to the path after the name of the hostname "danbooru.me".
Listing
The base URL is GET /artist_commentaries.json.
Search parameter format
All search parameters use URL hash format where "search" is the base object.
Example: search[PARAMETER]
Search attributes
All of the following are standard attributes with all of their available formats and qualifiers.
- Number syntax
id
post_id
created_at
updated_at
- Text syntax
original_title
original_description
translated_title
translated_description
Special search parameters
-
post_tags_match
- The commentary's post's tags match the given terms. Meta-tags not supported. -
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?
Note: The default order is ID descending.
Show
The base URL is GET /artist_commentaries/$id.json where $id is the artist commentary ID.
Note: This does a redirect to the post with that commentary when using the HTML interface.
Create or Update
The base URL is PUT /artist_commentaries/create_or_update.json
Create/update parameter format
All create parameters use URL hash format where "artist_commentary" is the base object.
Example: artist_commentary[PARAMETER]
Create/update parameters
- Required:
-
post_id
- The post ID the commentary belongs to. - 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
The base URL is PUT /artist_commentaries/$id/revert.json where $id is the post ID (not the artist commentary ID).
- Required:
- version_id - The artist commentary version ID to revert to.