-
Notifications
You must be signed in to change notification settings - Fork 285
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Small quality of life fixes #941
base: master
Are you sure you want to change the base?
Conversation
Screenshots of before and after would be appreciate @sanscontext :) |
cc @mrin9 |
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 |
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 |
@@ -401,7 +401,7 @@ export default function securitySchemeTemplate() { | |||
<div class="blue-text"> ${providedApiKeys.length} API key applied </div> | |||
<div style="flex:1"></div> | |||
<button class="m-btn thin-border" part="btn btn-outline" @click=${() => { onClearAllApiKeys.call(this); }}>CLEAR ALL API KEYS</button>` | |||
: html`<div class="red-text">No API key applied</div>` | |||
: html`<div class="red-text">No API key applied - <a href="#auth">Apply one here</a></div>` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#auth
wont be available always.it depends on which section the user is showing and also special care must be taken for focused view
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. |
I can take a look later this week |
Hey folks, it's been six months. Should I just close this? |
Hey folks, is there any way to get this looked at please? |
This PR:
✔️ 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)
✔️ Renders the
bearerFormat
string as the field hint text, for HTTP Bearer type auth, if one is set. (If not set, uses the originalapi-token
.)Before:
After:
✔️ Similarly, renders the
bearerFormat
string as the noun in the instructional text, if set. (If not set, uses the original "Token String".)Before:
After:
${v.securitySchemeId}
if there are, except I couldn't get this working or troubleshoot effectively with my rudimentary JS skills.Not working right now, but when it's done it would look something like this:
Before: two different auth formats with the same name, so you have to use the descriptive text to tell them apart.
After: much easier to see that these are different
Thanks all!