Improve API documentation: fix for demo server path, added 403 error responses, improved schema for paginated responses
#303
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.
This PR brings a few improvements to API docs.
By upgrading Scramble and Scramble PRO to
0.12.35and0.7.18, Cachet API docs will have a more accurate pagination information schema (links are optional, but when present – they'll be strings).Fixed demo server path (was
https://v3.cachethq.iobut the correct one ishttps://v3.cachethq.io/api).Added
/** @throws MissingAbilityException */annotation to theGuardsApiAbilitiestrait. This, in turn, improved documentation of endpoints that use this trait and now include a403response.Altogether, this makes the documentation more accurate and consumers of this API happier 🫶