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.

Sign up for GitHub

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

Jump to bottom

Adding consistency in boolean attribute naming #811

Merged
merged 2 commits into from
Oct 5, 2023
Merged

Adding consistency in boolean attribute naming #811

merged 2 commits into from
Oct 5, 2023

Conversation

floydtree
Copy link
Contributor

Description of changes:

  1. Adding a new attribute is_fix_available as a replacement for fix_available. This is to bring consistency in OCSF's boolean attributes
  2. deprecating fix_available
    Screenshot 2023-10-04 at 11 21 14 AM

@floydtree floydtree added findings Issues related to Findings Category grammar_consistency Issues related to the attribute grammar consistency work-stream non_breaking Non Breaking, backwards compatible changes labels Oct 4, 2023
@mikeradka
Copy link
Contributor

I love the idea of consistency, but just want to check - do we have this documented as a strict convention, and if not, should we?

Also was curious, it looks like there are a few others which aren't prepended with is_

image

@floydtree
Copy link
Contributor Author

floydtree commented Oct 4, 2023 •
edited
Loading

I love the idea of consistency, but just want to check - do we have this documented as a strict convention, and if not, should we?

Also was curious, it looks like there are a few others which aren't prepended with is_

I don't think we have strictly enforced it or have documented it yet. Probably good to do so down the road. In this PR though, just addressing the attribute in vuln object.

@floydtree floydtree requested a review from Aniak5 October 5, 2023 15:06
@floydtree
Copy link
Contributor Author

I am creating an issue to ensure we establish a convention for all the boolean type fields. #816

mikeradka
mikeradka approved these changes Oct 5, 2023
View reviewed changes
Copy link
Contributor

@mikeradka mikeradka left a comment

Choose a reason for hiding this comment

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

Looks good. We can tackle the convention in #816 . Thanks Rajas

Aniak5
Aniak5 approved these changes Oct 5, 2023
View reviewed changes
Copy link
Contributor

@Aniak5 Aniak5 left a comment

Choose a reason for hiding this comment

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

good call on this!

@Aniak5 Aniak5 merged commit 7dc132d into ocsf:main Oct 5, 2023
1 check passed
@floydtree floydtree deleted the vuln-fix branch October 5, 2023 18:53
@pagbabian-splunk pagbabian-splunk added the v1.1.0 Changes marked for v1.1.0 of OCSF label Jan 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@awhite456 awhite456 awhite456 approved these changes

@mikeradka mikeradka mikeradka approved these changes

@Aniak5 Aniak5 Aniak5 approved these changes

@jasonbreimer jasonbreimer Awaiting requested review from jasonbreimer

@pagbabian-splunk pagbabian-splunk Awaiting requested review from pagbabian-splunk pagbabian-splunk is a code owner

@irakledibm irakledibm Awaiting requested review from irakledibm

@zschmerber zschmerber Awaiting requested review from zschmerber zschmerber is a code owner

Assignees
No one assigned
Labels
findings Issues related to Findings Category grammar_consistency Issues related to the attribute grammar consistency work-stream non_breaking Non Breaking, backwards compatible changes v1.1.0 Changes marked for v1.1.0 of OCSF
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@floydtree @mikeradka @Aniak5 @awhite456 @pagbabian-splunk