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

docs: adds auth concept to glee docs #564

Merged
merged 12 commits into from
Nov 30, 2023

Conversation

afzal442
Copy link
Contributor

@afzal442 afzal442 commented Nov 5, 2023

Copy link
Member

@KhudaDad414 KhudaDad414 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left some comments.

docs/pages/auth-concept/authentication.md Outdated Show resolved Hide resolved
docs/pages/auth-concept/authentication.md Outdated Show resolved Hide resolved
docs/pages/auth-concept/authentication.md Outdated Show resolved Hide resolved
docs/pages/auth-concept/authentication.md Outdated Show resolved Hide resolved
docs/pages/auth-concept/authentication.md Outdated Show resolved Hide resolved
docs/pages/auth-concept/bearerToken.md Outdated Show resolved Hide resolved
docs/pages/auth-concept/bearerToken.md Outdated Show resolved Hide resolved
docs/pages/auth-concept/bearerToken.md Outdated Show resolved Hide resolved
docs/pages/auth-concept/index.md Outdated Show resolved Hide resolved
docs/pages/auth-concept/index.md Outdated Show resolved Hide resolved
@afzal442 afzal442 marked this pull request as ready for review November 13, 2023 06:41
docs/pages/auth-concept/authentication.md Outdated Show resolved Hide resolved
Comment on lines 112 to 114
// done(true)
//done(false, 401, "Unauthorized")
// done(false)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean the done() function parameters should be explained as well. something like:

Parameters

  1. Authentication Result (Boolean): true for success, false for failure.
  2. HTTP Status Code (Integer): Code for authentication failure (e.g., 401 for Unauthorized).
  3. Status Message (String): Description of the authentication result (e.g., "Unauthorized").

docs/pages/auth-concept/authentication.md Outdated Show resolved Hide resolved
@KhudaDad414
Copy link
Member

@oviecodes can you take a look here? 🙇

@oviecodes
Copy link
Contributor

oviecodes commented Nov 16, 2023

Hey @KhudaDad414 it means that the Client asyncapi.yaml file only needs to contain the security requirements that it makes use of.

KhudaDad414
KhudaDad414 previously approved these changes Nov 21, 2023
Copy link
Member

@KhudaDad414 KhudaDad414 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! let's wait for @Souvikns review.

Copy link

sonarcloud bot commented Nov 25, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@afzal442
Copy link
Contributor Author

/rtm

@asyncapi-bot asyncapi-bot merged commit b5a5655 into asyncapi:master Nov 30, 2023
12 checks passed
@afzal442 afzal442 deleted the create-auth-concept branch November 30, 2023 13:04
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 0.32.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

5 participants