rapi-doc / RapiDoc

RapiDoc -WebComponent for OpenAPI Spec
https://rapidocweb.com
MIT License
1.71k stars 285 forks source link

Small quality of life fixes #941

Open sanscontext opened 1 year ago

sanscontext commented 1 year ago

This PR:

Thanks all!

AdrianMachado commented 1 year ago

Screenshots of before and after would be appreciate @sanscontext :)

AdrianMachado commented 1 year ago

cc @mrin9

sanscontext commented 1 year ago

Thanks @AdrianMachado , I added some before/after screenshots, trying to limit it to just what I've touched in this PR.

I was thinking about the bearerFormat part, and I'd actually want to see some examples of how it's used in the wild before assuming it'd be helpful here. The OAS isn't very prescriptive on how this should be used, and "Hint" isn't going to mean the same thing to everyone. Would this be something we could poll the Discord for, for examples?

mrin9 commented 1 year ago

✔️ Adds a link to the #auth anchor on the "no api key set" message, so that readers get a CTA how to fix it. After: (I don't have a non-edited version to screenshot for a Before)

This may not be the case always. An user can always hide the auth section, in that case the link wont take it to anywhere

sanscontext commented 1 year ago

Thanks all, I'm open to additions to this PR. As I mentioned to @AdrianMachado, I'm not a developer so my changes here are rudimentary but high-impact on our end. It'd be nice not to have to add them to every new version of Rapidoc I pull down.

AdrianMachado commented 1 year ago

I can take a look later this week

sanscontext commented 11 months ago

Hey folks, it's been six months. Should I just close this?

sanscontext commented 2 months ago

Hey folks, is there any way to get this looked at please?