Feature/use gh openapi docs #100
Open
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
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.
The Cloud WS has developed gh-openapi-docs, a tool that generates standalone documentation pages from OpenAPI specs. This PR adds a new script that builds docs for any pushes to
develop,master, orrelease/*, and pushes the docs to thegh-pagesbranch. This will be especially useful for keeping historical versions of theservice-registryspec available once we make the jump to 1.1 and beyond.I've built some docs on my fork for different versions, which end up living at non-clashing URLs. See:
Cloud WS is using a tool like this for DRS and possibly it's other specs. See the "API Definition" table where older versions are available
@jaeddy @mcupak