Removes the TopBar form #103
Conversation
This removes the TopBar form, which removes any problems around it. Our doc page is only for our current API. Note, this doesn't need any custom build to accomplish, just a (non-intuitive) change to swagger-initializer.js. As this change is against the gh-pages branch, I can't also update build-bin/README.md on master. I'll do that in a separate PR once it is verified to fix the issue. Later, we can make GH automation to regenerate the dist by unzipping the swagger dist overwriting everything except our IDL and swagger-initializer.js. Signed-off-by: Adrian Cole <[email protected]>
|
@openzipkin/ui fyi as we have very little folks doing close looks at any UI change lately, I'm becoming more and more feature pessimistic. Anything we can disable is better as there are an army of vulnerability finding people out there, and it is hugely time consuming to answer them. |
swagger-initializer.js
Outdated
| @@ -1,14 1,15 @@ | |||
| window.onload = function() { | |||
There was a problem hiding this comment.
docs will basically say this file is from our site, and the rest of things that aren't IDL are from swagger. capiche? ;)
basically it should be obvious how extremely simple this gh-pages branch is, and that it is entirely intentionally dumb. I'll take on this documentation
swagger-initializer.js
Outdated
| window.ui = SwaggerUIBundle({ | ||
| url: "https://zipkin.io/zipkin-api/zipkin2-api.yaml", | ||
| dom_id: '#swagger-ui', | ||
| deepLinking: true, | ||
| presets: [ | ||
| SwaggerUIBundle.presets.apis, | ||
| SwaggerUIStandalonePreset | ||
| SwaggerUIStandalonePreset.slice(1) // index zero is the TopBar |
There was a problem hiding this comment.
Maybe worth linking the file since I guess this is reflecting implementation detail
https://github.com/swagger-api/swagger-ui/blob/master/src/standalone/presets/standalone/index.js
There was a problem hiding this comment.
done. that's a very good idea.
Signed-off-by: Adrian Cole <[email protected]>
|
thanks for the review @anuraaga! |
This removes the TopBar form, which removes any problems around it. Our doc page is only for our current API.
Note, this doesn't need any custom build to accomplish, just a (non-intuitive) change to swagger-initializer.js. I found out about this by searching issues in github and several are doing the same thing.
As this change is against the gh-pages branch, I can't also update build-bin/README.md on master. I'll do that in a separate PR once it is verified to fix the issue.
Later, we can make GH automation to regenerate the dist by unzipping the swagger dist overwriting everything except our IDL and swagger-initializer.js.
Before:
Now:
