Use Stoplight Elements to render OpenAPI docs #693
Merged
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
carlhoerberg
requested review from
kickster97,
snichme,
spuun and
viktorerlingsson
as code owners
|
Required (or a variant of it) by #692. Installing nodejs with a recent version in all distros (ubuntu 20.04, debian 11) is a hassle, and just required for building the static html. |
dentarg
reviewed
Jun 4, 2024
static/docs/index.html
Outdated
Comment on lines
7
to
8
| <script src="https://unpkg.com/@stoplight/elements/web-components.min.js"></script> | ||
| <link rel="stylesheet" href="https://unpkg.com/@stoplight/elements/styles.min.css"> |
There was a problem hiding this comment.
It is probably a good idea lock these to a certain version so they does not break on us unexpectedly. Using Subresource Integrity (SRI) we can also ensure that it is the correct version served from the CDN: https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity
There was a problem hiding this comment.
or download locally?
viktorerlingsson
approved these changes
Jun 4, 2024
There was a problem hiding this comment.
Agree with @dentarg about locking versions, otherwise looks good! 👍
viktorerlingsson
pushed a commit
that referenced
this pull request
Sep 20, 2024
Instead of compiling static html files from openapi.yaml using redoc the docs are now rendered in the browser using https://github.com/stoplightio/elements
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.
WHAT is this pull request doing?
Instead of compiling static html files from
openapi.yamlusingredocthe docs are now rendered in the browser using https://github.com/stoplightio/elementsHOW can this pull request be tested?
Compile and then browse to http://localhost:15672/docs/