Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I came across a few minor issues in the API documentation.
(1) In the example response for read shelf/book, the tags have
id
- but they do not haveid
just like at any other endpoint.(2) In the example response for read book, the page within
contents
does not have atype
- but a quick test on the demo shows that any object withincontents
has atype
.I also noticed some fields are missing in the example responses, e.g. pages have an
editor
field (and sometimesurl
) and users within entities also aslug
besidesname
andid
. I assume it's an unnecessary bloat of the example responses to add those?