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:10:57 +01:00
parent 848ef67467
commit 0d55dcd6ab
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
API.md
View File

@ -18,7 +18,7 @@ GET /wp-json/storygraph/v1/story/<id>
The following schema defines all fields that can exist within the response, excluding fields that are empty or `null` unless stated otherwise. So if there are no chapters, the chapter node will be missing. All values are escaped.
| Field | Description |
| Story Field | Description |
| :-- | :-- |
| id `integer` | ID of the story (on the site).
| guid `string` | Sufficiently unique global ID based on the original URL, type, and ID. Unreliable as link.
@ -56,6 +56,12 @@ The following schema defines all fields that can exist within the response, excl
| &emsp;➞ donation `string\|null` | URL to the story’s or author’s donation page.
| timestamp `integer` | Unix timestamp of when the response was compiled (GMT). May be cached.
| Story Field | Description |
| :-- | :-- |
| 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.
## Endpoint: Stories
Query this endpoint to retrieve a collection of stories and associated meta data. The response is paginated and cached for performance reasons, use the `page` argument to browse through the pages.