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 18:12:18 +01:00
parent fd3f813d01
commit 7725930da8
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
API.md
View File

@ -28,6 +28,16 @@ The following schema defines all fields that can exist within the response, excl
|  ➞ url `string\|null` | Author website.
| content `string` | Return value of `get_the_content()` without filters applied. Needs processing.
| description `string` | HTML string from TinyMCE. Needs processing.
| words `integer` | Total number of words of all chapters.
| ageRating `string` | Either Everyone, Teen, Mature, or Adult.
| chapterCount `integer` | Total number of chapters, excluding those marked as non-chapters.
| published `integer` | Unix timestamp of when the story was published (GMT).
| modified `integer` | Unix timestamp of when the story was last updated (GMT).
| protected `boolean` | Whether the story is protected by a password.
| images `object\|null` | Images associated with the story.
|  ➞ hotlinkAllowed `boolean` | Whether hotlinking images is allowed. Copy and host them yourself otherwise.
|  ➞ header `string|null` | URL of header image.
|  ➞ cover `string|null` | URL of cover image.
## Endpoint: Stories