Skip to content

Conversation

@ahouseholder
Copy link
Contributor

Renames the description attribute in ssvc._mixins._Base to definition. All other changes are incidental to that one change.

Important

This PR touches a lot of files, so pay attention to merge order if you're merging more than one PR in rapid succession.
Anticipate that outstanding branches may have merge conflicts.

@ahouseholder ahouseholder linked an issue Aug 27, 2025 that may be closed by this pull request
@ahouseholder ahouseholder added this to the 2025-09 milestone Aug 27, 2025
@ahouseholder ahouseholder changed the title Rename "description" attribute to "definition" Rename description attribute to definition Aug 27, 2025
@ahouseholder ahouseholder added tech/backend Back-end tools, code, infrastructure tech/data Data implementation (content of /data, data object instances, etc.) integration Related to integration of SSVC into another framework or system labels Aug 27, 2025
@ahouseholder ahouseholder self-assigned this Aug 27, 2025
@sei-vsarvepalli
Copy link
Contributor

Okay we are jumping on this one! running some tests first..

@sei-vsarvepalli
Copy link
Contributor

sei-vsarvepalli commented Aug 27, 2025

Some tests for generating schema are failing, when trying to recreate the schema and test it. These may have been failing before. Should we fix it? The namespace is missing it says, but when namespace is provided it still fails.

python -m ssvc.decision_tables.base
    validated_self = self.__pydantic_validator__.validate_python(data, self_instance=self)
pydantic_core._pydantic_core.ValidationError: 1 validation error for DecisionTable
key
  Field required [type=missing, input_value={'name': 'Test Table', 'd...schemaVersion': '2.0.0'}, input_type=dict]
    For further information visit https://errors.pydantic.dev/2.11/v/missing

@sei-vsarvepalli
Copy link
Contributor

Also the SSVC object ID validator is somewhere not right too.

  File "./src/ssvc/registry/__init__.py", line 67, in _handle_registration
    raise TypeError(f"Object {obj.id} is not a valid SSVC type.")
TypeError: Object ssvc:E:1.0.0 is not a valid SSVC type.

@ahouseholder
Copy link
Contributor Author

ahouseholder commented Aug 27, 2025

@sei-vsarvepalli running ssvc.decision_table.base has been broken for a while as DecisionTable has evolved. Generating schema should be done via doctools.py.

I'm getting 175 passing tests with pushd docker && docker-compose up --build test so I'm not sure what you're running that's throwing the second error mentioned.

…come broken as the object has evolved. So I'm just taking it out lest it lead others astray in troubleshooting.
@ahouseholder ahouseholder merged commit e5417cc into main Aug 28, 2025
4 checks passed
@ahouseholder ahouseholder deleted the 903-avoidreplace-json-key-description branch August 28, 2025 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

integration Related to integration of SSVC into another framework or system tech/backend Back-end tools, code, infrastructure tech/data Data implementation (content of /data, data object instances, etc.)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Avoid/replace JSON key description

3 participants