Switch to Stoplight Elements for docs render #8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
samdbmg
force-pushed
the
sammg-use-stoplight-elements
branch
from
84f9276
to
cd34ab9
Compare
18 tasks
|
Switching back to Draft - there's one endpoint that doesn't quite work here due to Redocly/redocly-cli#792 |
GeorginaShippey
approved these changes
Dec 20, 2023
Switches to Stoplight Elements to render HTML version of API spec
Makes the "Try It" box rendered in the documentation default to using the mock API that this repo can start.
Adds missing titles to some types so they appear in the render. Also removes some spurious whitespace.
Adds a script to rewrite part of the bundled API spec, to work around Redocly not having support for `patternProperties` (see also bug Redocly/redocly-cli#792)
samdbmg
force-pushed
the
sammg-use-stoplight-elements
branch
from
b784064
to
68f7980
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Details
Switches documentation render to Stoplight Elements, which pulls out and renders internal types (e.g. Timestamp and TimeRange), and better aligns with what we're doing internally.
Also switches to Stoplight Spectral for documentation linting, again for internal alignment and to reduce the number of tools in use.
Pivotal Story
Story URL: https://www.pivotaltracker.com/story/show/186709535
Related PRs
Followed by #9
Links to external test runs/working deployment
N/A
Submitter PR Checks
(tick as appropriate)
Reviewer PR Checks
(tick as appropriate)
Info on Cloudfit PRs