Miyuu's Image Board

Table of Contents

* 1. "Record field format":#dtext-record
* 2. "Associated attributes":#dtext-associations
* 3. "Nomenclature":#dtext-nomenclature
* 4. "Index":#dtext-index
* 5. "See also":#dtext-see-also
* 6. "External links":#dtext-external-links

The following includes the details of how to interface with the post version 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]

tags

[/td]

[td]string[/td]

[td]space delineated, tag format[/td]

[/tr]

[tr]

[td]

added_tags

[/td]

[td]array[/td]

[td]string, tag format[/td]

[/tr]

[tr]

[td]

removed_tags

[/td]

[td]array[/td]

[td]string, tag format[/td]

[/tr]

[tr]

[td]

rating

[/td]

[td]string[/td]

[td][g, s, q, e][/td]

[/tr]

[tr]

[td]

parent_id

[/td]

[td]integer[/td]

[td]>0 or null[/td]

[/tr]

[tr]

[td]

source

[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]

rating_changed

[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]

parent_changed

[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]

source_changed

[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]

version

[/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]

updater_addr_ip

[/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]

post

[/td]

[td]post[/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]

[/tbody]

[/table]

h4#nomenclature. Nomenclature

* Plural form: "post_versions"

** Used in the URL pathname

* Singular form: "post_version"

** Unused

* Version of: API:Posts

h4#index. Index

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/post_versions.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]

h6#search-attributes. Search attributes

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

* Number syntax

**

id

**

post_id

**

parent_id

**

updater_id

**

version

**

created_at

**

updated_at

* Text syntax

**

tags

**

rating

**

source

* Boolean syntax

**

rating_changed

**

parent_changed

**

source_changed

* Array syntax

**

added_tags

**

removed_tags

h6#special-search-parameters. Special search parameters

*

changed_tags

- Search where all tags must be either an added tag or removed tag

** The list of tags is space-delineated

*

all_changed_tags

- The same as

changed_tags

*

changed_tags

- Search where at least one tag must be either an added tag or removed tag

** The list of tags is space-delineated

*

tag_matches

- Case-insensitive search of the tag string with first tag from the input

** If asterisks ( * ) are missing from the input, it adds an asterisk to either side of the tag

*

updater_name

- Searches by updater name instead of updater ID

*

is_new

- Boolean syntax

** Shorthand search for

version=1

or

version=>1

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]