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

fix: change oauth type in asyncapi schema #1926

Merged
merged 2 commits into from
Nov 19, 2024
Merged

Conversation

spataphore1337
Copy link
Contributor

@spataphore1337 spataphore1337 commented Nov 19, 2024

Description

Added changes to the generation of AsyncAPI documentation in the OAuthBearer part. According to the AsyncAPI specification, the OAuthBearer is mapped to oauth2. Also adds a “$ref” field for mapping and generating documentation. It should be clarified in the future whether requiring this field is a bug or whether additional edits are needed.

Thank you to the following developers for their help:

  1. @Lancetnik for help with the bug and support during the fix;
  2. @KrySeyt for consultations on AsyncAPI in FastStream;
  3. @three-question-marks for spending time together while fixing this problem and studying AsyncAPI documentation at the same time;
  4. @dalelane for help in mapping Kafka Security Config to AsyncAPI types

Fixes #1631

Type of change

Please delete options that are not relevant.

  • Documentation (typos, code examples, or any documentation updates)
  • Bug fix (a non-breaking change that resolves an issue)
  • New feature (a non-breaking change that adds functionality)
  • Breaking change (a fix or feature that would disrupt existing functionality)
  • This change requires a documentation update

Checklist

  • My code adheres to the style guidelines of this project (scripts/lint.sh shows no errors)
  • I have conducted a self-review of my own code
  • I have made the necessary changes to the documentation
  • My changes do not generate any new warnings
  • I have added tests to validate the effectiveness of my fix or the functionality of my new feature
  • Both new and existing unit tests pass successfully on my local environment by running scripts/test-cov.sh
  • I have ensured that static analysis tests are passing by running scripts/static-analysis.sh
  • I have included code examples to illustrate the modifications

@Lancetnik Lancetnik added this pull request to the merge queue Nov 19, 2024
Merged via the queue into airtai:main with commit 4bc70b2 Nov 19, 2024
32 checks passed
@Lancetnik Lancetnik linked an issue Nov 19, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: documentation schema hosting returns blank page Feature: add sasl_oauthbearer support
3 participants