Miyuu's Image Board

api:comments

Table of Contents* 01. "Record field format":#dtext-record
* 02. "Associated attributes":#dtext-associations
* 03. "Nomenclature":#dtext-nomenclature
* 04. "Index":#dtext-index
* 05. "Show":#dtext-show
* 06. "Create":#dtext-create
* 07. "Update":#dtext-update
* 08. "Delete":#dtext-delete
* 09. "Undelete":#dtext-undelete
* 10. "See also":#dtext-see-also
* 11. "External links":#dtext-external-links

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


h4#record. Record field format


[table]

[thead]

[tr]

[th]Name[/th]

[th]Type[/th]

[th]Details[/th]

[/tr]

[/thead]

[tbody]

[tr]

[td]

id
[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]
post_id
[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]
body
[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]
score
[/td]

[td]integer[/td]

[td][/td]

[/tr]

[tr]

[td]
is_deleted
[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]
is_sticky
[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]
do_not_bump_post
[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]
creator_id
[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]
updater_id
[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]
created_at
[/td]

[td]timestamp[/td]

[td][/td]

[/tr]

[tr]

[td]
updated_at
[/td]

[td]timestamp[/td]

[td][/td]

[/tr]

[tr]

[td]
creator_ip_addr
[/td]

[td]inet[/td]

[td]Limited to Moderator+[/td]

[/tr]

[tr]

[td]
updater_ip_addr
[/td]

[td]inet[/td]

[td]Limited to Moderator+[/td]

[/tr]

[/tbody]

[/table]


h4#associations. Associated attributes


[table]

[thead]

[tr]

[th]Name[/th]

[th]Type[/th]

[th]Number[/th]

[th]Availability[/th]

[th]Details[/th]

[/tr]

[/thead]

[tbody]

[tr]

[td]

creator
[/td]

[td]user[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[tr]

[td]
updater
[/td]

[td]user[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[tr]

[td]
post
[/td]

[td]post[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[/tbody]

[/table]


h4#Nomenclature. Nomenclature


* Plural form: "comments"

** Used in the URL pathname

* Singular form: "comment"

** Used for write parameters (Help:API Write Requests)

* Versions: none


h4#index. Index


[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/comments.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]The default order is ID descending.[/td]

[/tr]

[/tbody]

[/table]


Note: 

group_by
as a parameter must be set to 
comment
, or else posts will be returned instead (e.g. 
group_by=comment
).


h5#search-attributes. Search attributes


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


* Number syntax

** 

id


** 
score


** 
created_at


** 
updated_at


* Text syntax

** 
body


* Boolean syntax

** 
is_deleted


** 
is_sticky


** 
do_not_bump_post


* Post syntax

** 
post


* User syntax

** 
creator


** 
updater


h5#special-search-parameters. Special search parameters


* 

body_matches
- Case-insensitive wildcard searching on the body text field.

* 
order
- Sets the order of results.

** 
post_id
- Orders by post ID.

** 
score
- Orders by comment score.

** 
updated_at
- Orders by updated_at timestamp.


h4#show. Show


[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/comments/$id.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]
$id
is the comment ID.[/td]

[/tr]

[/tbody]

[/table]


h4#create. Create


[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]POST[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/comments.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[/tbody]

[/table]


h5#create-parameters. Create parameters


* Required:

** 

post_id


** 
body


* Optional

** 
do_not_bump_post


h6. Restricted to Moderator+


* Optional

** 

is_sticky


h4#update. Update


[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]PUT/PATCH[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/comments/$id.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]
$id
is the comment ID.[/td]

[/tr]

[/tbody]

[/table]


h5#update-parameters. Update parameters


* Optional:

** 

body


** 
is_deleted


h6. Restricted to Moderator+


* Optional

** 

is_sticky


h4#delete. Delete


[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]DELETE[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/comments/$id.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]
$id
is the comment ID.[/td]

[/tr]

[/tbody]

[/table]


Note: This action can also be accomplished using the "update comment action":[#dtext-update] by setting 

is_deleted
to true.


h4#undelete. Undelete


[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]POST[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/comments/$id/undelete.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]
$id
is the comment ID.[/td]

[/tr]

[/tbody]

[/table]


Note: This action can also be accomplished using the "update comment action":[#dtext-update] by setting 

is_deleted
to false.


h4#see-also. See also


* Help:Common URL Parameters

* Help:API


h4#external-links. External links


[table]

[tbody]

[tr]

[td]Controller[/td]

[td][/td]

[td][/td]

[/tr]

[tr]

[td]Model[/td]

[td][/td]

[/tr]

[tr]

[td]Policy[/td]

[td][/td]

[/tr]

[/tbody]

[/table]

Revision 4 by Anonymous at 2025-04-20 20:26:21.984839