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: added content for securing operations #2172

Closed
wants to merge 14 commits into from
Closed

docs: added content for securing operations #2172

wants to merge 14 commits into from

Conversation

BhaswatiRoy
Copy link
Collaborator

Fix: #1513

Content:

Operations Security
Implementation
Work: GSoD 2023 issue

Continuation: #1881

@netlify
Copy link

netlify bot commented Sep 26, 2023

Deploy Preview for shimmering-choux-eb0798 ready!

Name Link
🔨 Latest commit 13ae5ac
🔍 Latest deploy log https://app.netlify.com/sites/shimmering-choux-eb0798/deploys/65602c87b48f470008f64764
😎 Deploy Preview https://deploy-preview-2172--shimmering-choux-eb0798.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@BhaswatiRoy BhaswatiRoy changed the title added securing-operations docs: added content for securing operations Sep 26, 2023
Copy link
Member

@derberg derberg 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, 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.
Copy link
Member

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

Copy link
Collaborator Author

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?

Copy link
Collaborator Author

@BhaswatiRoy BhaswatiRoy Nov 24, 2023

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.

@BhaswatiRoy
Copy link
Collaborator Author

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.

@BhaswatiRoy BhaswatiRoy requested a review from derberg November 26, 2023 06:01
@derberg derberg deleted the branch asyncapi:next-major-spec December 5, 2023 09:40
@derberg derberg closed this Dec 5, 2023
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.

3 participants