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

Name	Type	Details
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

Name	Type	Number	Availability	Details
post	post	single	required	Post 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 Method	GET
Base URL	/artist_commentaries.json
Type	read request
Description	The 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 Method	GET
Base URL	/artist_commentaries/$id.json /posts/$post_id/artist_commentary.json
Type	read 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 Method	PUT
Base URL	/artist_commentaries/create_or_update.json /posts/$post_id/artist_commentary/create_or_update.json
Type	write 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 Method	PUT
Base URL	/artist_commentaries/$id/revert.json /posts/$post_id/artist_commentary/revert.json
Type	write 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

Controller	https://github.com/danbooru/danbooru/blob/master/app/controllers/artist_commentaries_controller.rb
Model	https://github.com/danbooru/danbooru/blob/master/app/models/artist_commentary.rb
Policy	https://github.com/danbooru/danbooru/blob/master/app/policies/artist_commentary_policy.rb

View wiki