Add redoc flag to generate and link to OpenAPI spec #33
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
Adds functions that produce a URL of format https://raw.githubusercontent.com/anz-bank/sysl-catalog/master/ by grabbing the remote-url via git Currently only handles github.com and github enterprise
Adds a redoc html template which is used to display OpenAPI specs
Adds a function which is called in the template This registers a redoc file to be created and also creates a link to the redoc file
Add --redoc flag to CLI Adds redoc diagram generation in registered files
cuminandpaprika
changed the title
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.
Summary
This PR adds a
--redocflag which generates a Redoc page which is linked to from the docs. This only occurs for OpenAPI or Swagger files imported into Sysl e.gimport specs/openapi.yaml as simple.Redoc Link
Redoc Page
To see what this looks like, you can refer to https://cuminandpaprika.github.io/sysl-catalog/ as this feature can't be tested locally as Redoc can't serve local OpenAPI spec files (Redocly/redoc#149)