Skip to content
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

Better support for custom security schemes and security scheme descriptions #1794

Open
jensljungblad opened this issue Sep 30, 2021 · 2 comments

Comments

@jensljungblad
Copy link

jensljungblad commented Sep 30, 2021

Is your feature request related to a problem?

@philsturgeon asked me to open this after discussing on Slack.

Implementing a security scheme with a custom schema type should technically be possible. The OpenAPI spec only says the scheme SHOULD be registered in the IANA registry, not that it MUST.

So this should work:

components:
  securitySchemes:
    auth:
      type: http
      scheme: Custom-Type

security:
  - auth: []

However it only renders as: “auth coming soon”.

Related: Any description you add to a security scheme gets rendered, but it also renders Element's default description, which could have contradicting statements. If you provide your own description, I don't think Element should render the default one.

Describe the solution you'd like

It would be great if it accepted the custom type!

@philsturgeon philsturgeon added help wanted enhancement New feature or request labels Oct 1, 2021
@mpodlasin
Copy link
Contributor

https://github.com/stoplightio/elements/pull/983/files

Here is an example of adding a sec scheme support.

WARNING! This is a more involved, complex issue. If you decide that you are brave enough, give me a ping. I'll do everything I can to help you. 🙏

@mnaumanali94 mnaumanali94 added p/medium t/bug Something isn't working triaged and removed enhancement New feature or request labels Oct 25, 2021
@jensljungblad
Copy link
Author

Any way this will be added? :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants