feat: update input file schema to include configurable classifications for signals #2800
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
abraemer
force-pushed
the
update-schema-with-license-classification
branch
from
8fda254 to
baec23f
Compare
Hellgartner
reviewed
Feb 19, 2025
| @@ -121,6 +133,11 @@ | |||
| "type": "string", | |||
| "description": "Indication on how critical a signal is. Possible values are \"high\" and \"medium\"." | |||
| }, | |||
| "classification": { | |||
| "type": "number", | |||
| "description": "Signal classification by usage, usually based on the license. Zero corresponds to unrestricted usage ehile higher levels mean more and more restrictions. Exact values and labels need to be configured in the config section.", | |||
abraemer
force-pushed
the
update-schema-with-license-classification
branch
from
baec23f to
eebf3a0
Compare
vasily-pozdnyakov
requested changes
Feb 19, 2025
| "classifications": { | ||
| "type": "object", | ||
| "description": "Mapping of classification values to human-readable labels. See \"classification\" field of \"externalAttribution\".", | ||
| "additionalProperties": true |
There was a problem hiding this comment.
this is not necessary ("additionalProperties": true), at least in the exporter the schema validation fails with the property.
There was a problem hiding this comment.
I read a bit more about JSON Schema: We could make this more restrictive by using patternProperties:
"classifications": {
....
"patternProperties": {
"^[0-9]+$": {
"type":"string"
}
}What do you think about that?
There was a problem hiding this comment.
I would propose to keep it simple for now. I also tried to test it with the pattern, and it does not work as expected.
There was a problem hiding this comment.
As discussed, let's proceed this way.
|
I also generated a new .opossum file with the fields and it works fine with your changes. |
abraemer
force-pushed
the
update-schema-with-license-classification
branch
from
b2791ed to
a2f8166
Compare
vasily-pozdnyakov
approved these changes
Feb 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of changes
Introduces a new field on
externalAttributionscalledclassification. It is a positive integer and its meaning (i.e. text label) can be configured via a new mappingclassifications. In anticipation of further configurable items in the future, a new top-level keyconfigis introduced withclassificationbeing its only subkey currently.Context and reason for change
We want to replace criticality by something more universally usable. Thus we introduce its successor in this PR and will build on this is in following work.
No further changes are required at this point. Opening files with OpossumUI and saving them preserves the
classificationinformation out-of-the-box since the input file is never changed.Compatibility
This change is backwards compatible: new versions of OpossumUI can open old opossum files. However, new opossum files (with config and/or classification) cannot be opened by old OpossumUI releases.
How can the changes be tested
There should be no functional changes because we just added optional fields. Everything that worked before still works.