Skip to content

Conversation

@ahouseholder
Copy link
Contributor

This PR replaces #738, which we merged too soon and reverted in #741

This PR modifies the "Track *" value in the CISA OutcomeGroup to be "Monitor". Based on feedback received that having two closely-named values "Track" and "Track *" can be a source of confusion for users of that outcome group.

Two incidental changes are also included:

  • Fixed the key values for Attend and Act in the python version of the CISA OutcomeGroup to match the keys found in docs/ssvc-calc/CISA-Coordinator.json
  • Updated the OutcomeGroup base object type hint to reflect actual usage (values are a tuple instead of a list)

CoPilot Summary

This pull request includes several updates to the docs/ssvc-calc and src/ssvc/outcomes directories to standardize terminology and improve code structure. The most important changes include renaming "Track*" to "Monitor" in JSON and HTML files, updating the OutcomeGroup class to use tuples instead of lists, and restructuring outcome groups in the codebase.

Terminology Standardization:

  • docs/ssvc-calc/CISA-Coordinator.json: Renamed "Track*" to "Monitor" in multiple entries to standardize terminology. [1] [2] [3] [4] [5]
  • docs/ssvc-ccalc/findex.html and docs/ssvc-calc/old_index.html: Updated "Track*" to "Monitor" in the vulnerability scoring decisions section. [1] [2]

Code Structure Improvements:

  • src/ssvc/outcomes/base.py: Changed the outcomes attribute in the OutcomeGroup class from a list to a tuple for better immutability and performance.
  • src/ssvc/outcomes/groups.py: Updated the OutcomeGroup instances to use the new "Monitor" terminology and restructured the CISA outcome group. Additionally, added new descriptions and keys for the "Act" outcome. [1] [2] [3] [4] [5] [6]

@ahouseholder ahouseholder marked this pull request as draft March 11, 2025 19:32
@ahouseholder ahouseholder requested a review from j--- March 11, 2025 19:32
@ahouseholder ahouseholder self-assigned this Jun 6, 2025
Copy link
Contributor

@sei-vsarvepalli sei-vsarvepalli left a comment

Choose a reason for hiding this comment

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

I think some of these will get overridden with the later PR's but approving it anyway. so it is not blocked.

@ahouseholder ahouseholder added content/semantic Changes to the semantic content of the SSVC documentation tech/data Data implementation (content of /data, data object instances, etc.) labels Jul 1, 2025
@sei-vsarvepalli
Copy link
Contributor

This PR should probably be abandoned as these changes will go into src/ssvc/outcomes/cisa/scoring.py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content/semantic Changes to the semantic content of the SSVC documentation tech/data Data implementation (content of /data, data object instances, etc.)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Change "Track *" to "Monitor" in our representation of CISA's tree

3 participants