Skip to content

Create vscode schema #3860

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

Draft
xqi-splunk wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

Create vscode schema #3860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90e65ef
Add yaml schemas in vscode settings.json
xqi-splunk Jan 13, 2026
0922ef1
Add redhat yaml extension recommendation
xqi-splunk Jan 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .vscode/extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"recommendations": [
"redhat.vscode-yaml"
]
}
14 changes: 13 additions & 1 deletion .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,17 @@
"python.testing.pytestEnabled": true,
"python.terminal.activateEnvironment": true,
"python.envFile": "${workspaceFolder}/.env",
"python.testing.cwd": "${workspaceFolder}"
"python.testing.cwd": "${workspaceFolder}",
"yaml.schemas": {
"./schemas/RemovedContent.schema.json": "removed/*/*.yml",
"./schemas/Baseline.schema.json": ["baselines/*.yml", "!removed/baselines/*.yml"],
"./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

@pyth0n1c pyth0n1c Jan 13, 2026

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

@xqi-splunk xqi-splunk Jan 13, 2026

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.

"./schemas/KVStoreLookup.schema.json": "lookups/kvstore/*.yml",
"./schemas/Macro.schema.json": "macros/*.yml",
"./schemas/Schedule.schema.json": "schedules/*.yml",
"./schemas/Story.schema.json": ["stories/*.yml", "!removed/stories/*.yml"]
}
}
Loading