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

feat: security support added to operation and operationTrait #189

Merged
merged 1 commit into from
Apr 14, 2022

Conversation

LokeshRishi
Copy link

2 passing (789ms)

----------|---------|----------|---------|---------|-------------------

File % Stmts % Branch % Funcs % Lines Uncovered Line #s
All files 100 100 100 100
index.js 100 100 100 100
---------- --------- ---------- --------- --------- -------------------

Description
Updates to include 'security' at operation and operationTrait level.

Related issue(s)
asyncapi/spec#584

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@sonarqubecloud
Copy link

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

@smoya
Copy link
Member

smoya commented Mar 31, 2022

Thanks for the PR @LokeshRishi! would you mind changing the title of this PR adding a prefix to be compliant with Conventional Commits? feat: prefix seems the right one.

@@ -616,6 +616,12 @@
"operationId": {
"type": "string"
},
"security": {
Copy link
Member

@smoya smoya Mar 31, 2022

Choose a reason for hiding this comment

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

Would it make sense to extract this into a new definition called SecurityRequirements or similar? Then you will just need to use it by "$ref": "#/definitions/SecurityRequirements"

Copy link

@sekharbans-ebay sekharbans-ebay Mar 31, 2022

Choose a reason for hiding this comment

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

Would it make sense to extract this into a new definition called SecurityRequirements or similar? Then you will just need to use it by "$ref": "#/definitions/SecurityRequirements"

Hi @smoya - Its an array of SecurityRequirements. Not sure if just indicating an array of a complex definition warrants a new definition. If so, such a pattern would need to apply consistently to all similar constructs that refer to an array (tags for example). Not sure it carries much benefits. At least for me - not creating a new definition but just knowing its an array of an existing definition is easier. Up to you folks :)

Copy link
Member

Choose a reason for hiding this comment

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

Fair enough 👍 I agree we would need to be consistent and lot of changes will need to be applied.

@LokeshRishi LokeshRishi changed the title Security support added to operation and operationTrait feat: security support added to operation and operationTrait Mar 31, 2022
Copy link
Member

@smoya smoya left a comment

Choose a reason for hiding this comment

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

LGTM, however we need a +1 of a Code Owner.

Copy link
Collaborator

@dalelane dalelane left a comment

Choose a reason for hiding this comment

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

LGTM

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.

@fmvilas only your approval is missing

I put asyncapi/spec#584 on Stage 2,
once we merge this and parser PR, then we can set Stage 3 and merge

@smoya
Copy link
Member

smoya commented Apr 14, 2022

/rtm

@asyncapi-bot
Copy link
Contributor

Hello, @smoya! 👋🏼
This PR is not up to date with the base branch and can't be merged.
Please update your branch manually with the latest version of the base branch.
PRO-TIP: Add a comment to your PR with the text: /au or /autoupdate and our bot will take care of updating the branch in the future. The only requirement for this to work is to enable Allow edits from maintainers option in your PR.
Thanks 😄

@smoya
Copy link
Member

smoya commented Apr 14, 2022

/au

@asyncapi-bot asyncapi-bot merged commit 7b442f6 into asyncapi:2022-04-release Apr 14, 2022
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 2.14.0-2022-04-release.1 🎉

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.

7 participants