From 72610429d977a0f01515466869f6f7078723bf9a Mon Sep 17 00:00:00 2001 From: Tetrakern <26898880+Tetrakern@users.noreply.github.com> Date: Sat, 18 Feb 2023 23:27:02 +0100 Subject: [PATCH] Update API.md --- API.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/API.md b/API.md index faf99e79..c15f380b 100644 --- a/API.md +++ b/API.md @@ -28,6 +28,7 @@ The following schema defines all fields that can exist within the response, excl | author `object\|null` | Author node. |  ➞ name `string` | Author name. |  ➞ 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. | description `string` | HTML string from TinyMCE. Needs processing. | 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. | url `string` | Current URL 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. | group `string\|null` | Group of the chapter. | author `object\|null` | Author node. |  ➞ name `string` | Author name. |  ➞ 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). | 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. +| 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