malhuda/fictioneer
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 112 Wiki Activity

Update API.md

Browse Source
This commit is contained in:
Tetrakern 2023-02-18 23:27:02 +01:00
parent 330c7a8ba3
commit 72610429d9
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
API.md
View File

@ -28,6 +28,7 @@ The following schema defines all fields that can exist within the response, excl
| author `object\|null` | Author node. | author `object\|null` | Author node.
|  ➞ name `string` | Author name. |  ➞ name `string` | Author name.
|  ➞ url `string\|null` | Author website. |  ➞ url `string\|null` | Author website.
| coAuthors `[object]\|null` | Array of co-author nodes. Same as the author node.
| content `string` | Return value of `get_the_content()` without filters applied. Needs processing. | content `string` | Return value of `get_the_content()` without filters applied. Needs processing.
| description `string` | HTML string from TinyMCE. Needs processing. | description `string` | HTML string from TinyMCE. Needs processing.
| words `integer` | Total number of words of all chapters. | words `integer` | Total number of words of all chapters.
@ -62,17 +63,26 @@ The following schema defines all fields that can exist within the response, excl
| guid `string` | Sufficiently unique global ID based on the original URL, type, and ID. Unreliable as link. | guid `string` | Sufficiently unique global ID based on the original URL, type, and ID. Unreliable as link.
| url `string` | Current URL of the chapter. | url `string` | Current URL of the chapter.
| language `string` | Language code of the chapter. | language `string` | Language code of the chapter.
| prefix `string\|null` | Title prefix, such as "Act 1".
| title `string` | Title of the chapter. | title `string` | Title of the chapter.
| group `string\|null` | Group of the chapter. | group `string\|null` | Group of the chapter.
| author `object\|null` | Author node. | author `object\|null` | Author node.
|  ➞ name `string` | Author name. |  ➞ name `string` | Author name.
|  ➞ url `string\|null` | Author website. |  ➞ url `string\|null` | Author website.
| coAuthors `[object]\|null` | Array of co-author nodes. Same as the author node.
| published `integer` | Unix timestamp of when the chapter was published (GMT). | published `integer` | Unix timestamp of when the chapter was published (GMT).
| modified `integer` | Unix timestamp of when the chapter was last updated (GMT). | modified `integer` | Unix timestamp of when the chapter was last updated (GMT).
| protected `boolean` | Whether the chapter is protected by a password. | protected `boolean` | Whether the chapter is protected by a password.
| words `integer` | Number of words. | words `integer` | Number of words.
| nonChapter `boolean` | Whether the chapter is marked as non-chapter. | nonChapter `boolean` | Whether the chapter is marked as non-chapter.
| ageRating `string` | Either Everyone, Teen, Mature, or Adult. | ageRating `string\|null` | Either Everyone, Teen, Mature, or Adult (if different from story).
| warning `string\|null` | Simple content warning notice.
| taxonomies `object\|null` | Taxonomy collection node.
|  ➞ tags `[string]\|null` | Array of tags.
|  ➞ fandoms `[string]\|null` | Array of fandoms.
|  ➞ characters `[string]\|null` | Array of characters.
|  ➞ warnings `[string]\|null` | Array of warnings.
|  ➞ genres `[string]\|null` | Array of genres.
## Endpoint: Stories ## Endpoint: Stories