Skip to content

Conversation

@xqi-splunk
Copy link
Collaborator

Details

  • Update .vscode/settings.json to add yaml schema configuration
  • Add .vscode/extensions.json to add RedHat YAML as recommended extension
  • Update README.md to recommend user install RedHat YAML

Checklist

  • Validate name matches <platform>_<mitre att&ck technique>_<short description> nomenclature
  • CI/CD jobs passed ✔️
  • Validated SPL logic.
  • Validated tags, description, and how to implement.
  • Verified references match analytic.
  • Confirm updates to lookups are handled properly.

Notes For Submitters and Reviewers

  • If you're submitting a PR from a fork, ensuring the box to allow updates from maintainers is checked will help speed up the process of getting it merged.
  • Checking the output of the build CI job when it fails will likely show an error about what is failing. You may have a very descriptive error of the specific field(s) in the specific file(s) that is causing an issue. In some cases, its also possible there is an issue with the YAML. Many of these can be caught with the pre-commit hooks if you set them up. These errors will be less descriptive as to what exactly is wrong, but will give you a column and row position in a specific file where the YAML processing breaks. If you're having trouble with this, feel free to add a comment to your PR tagging one of the maintainers and we'll be happy to help troubleshoot it.
  • Updates to existing lookup files can be tricky, because of how Splunk handles application updates and the differences between existing lookup files being updated vs new lookups. You can read more here but the short version is that any changes to lookup files need to bump the the date and version in the associated YAML file.

@xqi-splunk xqi-splunk self-assigned this Jan 13, 2026
@xqi-splunk xqi-splunk requested a review from pyth0n1c January 13, 2026 22:23
@pyth0n1c pyth0n1c marked this pull request as draft January 13, 2026 22:38
@pyth0n1c
Copy link
Collaborator

Presently marked as draft since this requires some other pending changes in the repo 😄

"./schemas/CSVLookup.schema.json": "lookups/csv/*.yml",
"./schemas/Dashboard.schema.json": "dashboards/*.yml",
"./schemas/DataSource.schema.json": "data_sources/*.yml",
"./schemas/EventBasedDetection.schema.json": ["detections/*.yml", "!removed/detections/*.yml"],
Copy link
Collaborator

Choose a reason for hiding this comment

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

We will intentionally not keep removed content in line with updates to the spec. Removed content should only be validated based on fields required for "RemovedContent" which we already have on line 11. I believe this second path (removed/detections/*.yml) should be removed.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

When I removed the !removed/detections/*.yml, the files under e.g. removed/detections/*.yml get validated by both schema (RemovedContent.schema.json and EventBasedDetection.schema.json). Since we only want the removed content to be validated against the RemovedContent.schema.json, I explicitly specify for schema e.g. EventBasedDetection.schema.json don't validate files under removed directory.

@xqi-splunk xqi-splunk force-pushed the create-vscode-schema branch from 74c7ba6 to 0922ef1 Compare January 13, 2026 22:51
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.

2 participants