Add FAQ for Object State#134
Draft
mikeradka wants to merge 8 commits into
Draft
Conversation
…uirements Signed-off-by: Michael Radka <mradka@splunk.com>
mikeradka
added
documentation
Contributor
Author
|
PR is on hold until this is convention is definitively sorted. |
mikeradka
added a commit
to ocsf/ocsf-schema
that referenced
this pull request
May 27, 2026
#### Related Issue: - #1601 #### Related PRs: - #1597 - ocsf/ocsf-docs#134 #### Description of changes: This PR deprecates the `_result` attributes that are used to represent updates to an object, in lieu of using the new `updated_` convention. | Deprecated | New | Committed | | ------------- | ------------- | ------------- | | `entity_result` | `updated_entity` | ✅ | | `file_result` | `updated_file`. Address new `link_target` object in separate PR. | ✅| | `resources_result` | `updated_resources` | ✅ | | `web_resources_result` | `updated_web_resources` | ✅ | Also added a few project words for the linter (`metaschemas`, `CLSID`), fixed a previous typo in CHANGELOG, and cleaned up minor json whitespace. # Vote Here: 👍 : deprecate these attributes in 1.9 👎 : do not deprecate these attributes in 1.9
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issue: ocsf-schema/issues/1601
Realized by Related PR: ocsf-schema/pull/1597
This PR adds an FAQ to describe how OCSF conventions handle pre/post event state for entities.