docs: Add server urls to swagger-ui #1330
Conversation
| @@ -6,6 +6,5 @@ const spec = require('./openapi-v1.yaml'); | |||
| const ui = SwaggerUI({ | |||
| spec, | |||
| dom_id: '#spec', | |||
| supportedSubmitMethods: [] | |||
| supportedSubmitMethods: ["get", "post"] | |||
There was a problem hiding this comment.
Thank you so much @PierreBesson for the contribution and adding the servers option! 💯
However, currently the Try it out feature in swagger UI of Sidecar is disabled due to a CORS issue :
- related sidecar comment and related PR
- error received when using the
Try it outbutton (if enabled e.g. while connected in polkadot public sidecar)Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at https://polkadot-public-sidecar.parity-chains.parity.io/runtime/code. (Reason: CORS header ‘Access-Control-Allow-Origin’ missing). Status code: 200. - related resource : "Reason: CORS header 'Access-Control-Allow-Origin' missing"
So I am not sure if at this moment we would like to enable it again and tackle this CORS error.
cc @TarikGul
There was a problem hiding this comment.
Via Pierres comment above CORS headers have been added on the Server-side for https://paritytech.github.io/ so we should be totally fine!
There was a problem hiding this comment.
My bad! I rushed to check the changes and missed the description!
There was a problem hiding this comment.
Yes CORS has been dealt with.
Thanks so much for setting this up! |
TarikGul
changed the title
PierreBesson
force-pushed
the
pib-swagger-ui-server-urls
branch
from
282d6d6
to
f1275c6
Compare
Add public sidecar URLs to swagger-ui to let people try out API requests. CORS headers have been set up on the server-side to allow requests from https://paritytech.github.io/ to be accepted.