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:17:54 +01:00
parent 287a32174a
commit 330c7a8ba3
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
API.md
View File

@ -46,7 +46,7 @@ The following schema defines all fields that can exist within the response, excl
|  ➞ characters `[string]\|null` | Array of characters.
|  ➞ warnings `[string]\|null` | Array of warnings.
|  ➞ genres `[string]\|null` | Array of genres.
| chapters `[object]\|null` | Chapter collection node. See **Chapter Fields**.
| chapters `[object]\|null` | Array of chapter nodes. See **Chapter Fields**.
| support `object\|null` | Support collection node.
|  ➞ topwebfiction `string\|null` | URL to story’s TopWebFiction entry.
|  ➞ patreon `string\|null` | URL to the story’s or author’s Patreon page.
@ -61,6 +61,18 @@ The following schema defines all fields that can exist within the response, excl
| id `integer` | ID of the chapter (on the site).
| guid `string` | Sufficiently unique global ID based on the original URL, type, and ID. Unreliable as link.
| url `string` | Current URL of the chapter.
| language `string` | Language code of the chapter.
| title `string` | Title of the chapter.
| group `string\|null` | Group of the chapter.
| author `object\|null` | Author node.
|  ➞ name `string` | Author name.
|  ➞ url `string\|null` | Author website.
| published `integer` | Unix timestamp of when the chapter was published (GMT).
| modified `integer` | Unix timestamp of when the chapter was last updated (GMT).
| protected `boolean` | Whether the chapter is protected by a password.
| words `integer` | Number of words.
| nonChapter `boolean` | Whether the chapter is marked as non-chapter.
| ageRating `string` | Either Everyone, Teen, Mature, or Adult.
## Endpoint: Stories