Skip to content

Commit 40cc9aa

Browse files
docs: add release notes for v6.0.0
1 parent 6f8b98d commit 40cc9aa

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

docs/release_notes.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Release Notes - Pytest-splunk-addon 6.0.0
2+
3+
## Breaking Changes
4+
- Removed the support of cim-field-report generation.
5+
6+
7+
## New features
8+
9+
- Added support for CIM v6.0.2
10+
- New data models added:
11+
- Data Access
12+
- Database
13+
- Event Signature
14+
- Interprocess Messaging
15+
- Computer Inventory
16+
- JVM
17+
- Performance
18+
- Ticket Management
19+
- Updated fields with expected values and conditions.
20+
- Eg: Added expected values ["critical","high","medium","low","informational"] for severity field in Malware data model.
21+
- For existing data models updated fields to required or optional based on CIM App Jsons.
22+
- Eg: For Alert data model, body field is now marked as optional(as it is deprecated) and description is marked as required which was previously optional.
23+
- So now if addon does not extract the description field for events tagged with Alert data model, then this will lead to failures for tests template: `test_cim_required_fields*` for those samples
24+
- Furthermore, recommended fields have also been added to data models
25+
- Eg: For Data Access fields like object_category and user_name are added as recommended fields.
26+
- Again if the addon does not extract these fields then tests with test template : `test_cim_fields_recommended*` will fail for those samples.
27+
- If the failures for test templates shown above are observed then it is recommended to extract those fields as the updates in all the Data models have been made with guidance of the SMEs.
28+
29+
## Bug fixes
30+
31+
- Fixed the issue with the token replacement for the fields defined under `other_mappings` for the sample event.

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,4 @@ nav:
7777
- CimComplianceReport: "api_reference/cim_compliance_report.md"
7878
- Contributing: "contributing.md"
7979
- Troubleshooting: "troubleshoot.md"
80+
- Release Notes: "release_notes.md"

0 commit comments

Comments
 (0)