-
-
Notifications
You must be signed in to change notification settings - Fork 681
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: added content for securing operations #2172
Conversation
✅ Deploy Preview for shimmering-choux-eb0798 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
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.
left some comments, you describe v2 and scope is v3
The security property is an array where you can define one or more security requirement objects. | ||
|
||
For example, let's say you have an AsyncAPI document with a channel called users and two operations within that channel: createUser and getUser. | ||
The server-level security is set to use API key authentication for all operations within all channels. |
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.
you cannot enforce as it is not about overriding,
it is like providing alternative for what is already in the server. Of course you can do a server without security, then have different operations and channels on the same server, each operation with different security - still, it is not overriding/enforcing if you know what I mean
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.
I am unable to understand how to improve the content as per your suggestions.
could you please attach some examples or maybe give me a bit more info about the same?
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.
you cannot enforce as it is not about overriding,
it is like providing alternative for what is already in the server. Of course you can do a server without security, then have different operations and channels on the same server, each operation with different security - still, it is not overriding/enforcing if you know what I mean
I have removed the line that stated about enforcing/overriding, though not sure if I still was able to resolved the suggestion.
Hello @derberg thanks for your review, I have implemented the suggested changes. Do please let me know if I need to add/remove anything else. |
Fix: #1513
Content:
Operations Security
Implementation
Work: GSoD 2023 issue
Continuation: #1881