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 15:36:05 +01:00
parent b36ea4c9bb
commit cd497bbd10
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
API.md
View File

@ -8,6 +8,22 @@
GET /wp-json/storygraph/v1/story/<id> GET /wp-json/storygraph/v1/story/<id>
``` ```
| Argument | Description |
| :-- | :-- |
| id | ID of the story.
### Schema
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 |
| :-- | :-- |
| 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.
| url `string` | Current URL of the story.
| language `string` | Language code of the story, not necessarily chapters.
| title `string` | Title of the story.
## Endpoint: Stories ## 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. 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.