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

Auth support for schema $refs in AsyncAPI files #1032

Open
rospe opened this issue Dec 16, 2024 · 0 comments
Open

Auth support for schema $refs in AsyncAPI files #1032

rospe opened this issue Dec 16, 2024 · 0 comments

Comments

@rospe
Copy link

rospe commented Dec 16, 2024

Use Case

Our AsyncAPI messages usually hold a reference to an external schema. Accessing this external schema is protected, I would need to send an OAuth2 access token along. Currently the generation job fails with a 401.

Proposed Solution

Since every external website requires a different kind of authentication, a configuration file with a map from authority (host name) to security mechanism is required.
In my case, that would be OAuth with client credentials, so I would like to provide the token server URL, client id and secret.

Implementation Notes

The implementation should be able to handle the lookup for the security mechanism for each reference in the config, download an active token if required and use that as bearer token in the request.
Reusing the token for further requests as long as it is valid is recommended.

Community Notes

  • Please vote by adding a 👍 reaction to the issue to help us prioritize.
  • If you are interested to work on this issue, please leave a comment.
  • If this issue is labeled needs-discussion, it means the spec has not been finalized yet. Please reach out in the EventCatalog Discord.
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

1 participant