Refactors role-specific properties into entities #776
Conversation
Signed-off-by: Steve Springett <[email protected]>
stevespringett
added
request for comment
RFC notice sent
There was a problem hiding this comment.
Pull request overview
This pull request introduces a new entity schema to CycloneDX 2.0 that refactors role-specific properties into a unified entity structure. The change implements issue #718 by adding new entity types (entity, entityChoice, and entities) along with a comprehensive role taxonomy to the common schema model.
Changes:
- Adds
entityobject definition with person/organization roles and priority handling - Introduces predefined and custom role taxonomies covering 27 predefined roles
- Creates
entityChoiceandentitiescollection types for flexible entity referencing
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| }, | ||
| "entity": { | ||
| "type": "object", | ||
| "title": "Entity", |
There was a problem hiding this comment.
"entity" for id, and "Entity" for title - a much too broad term.
please use a more narrow term.
background: every item of a collection is an entity. every banana is an entity of fruit. ...
| } | ||
| ] | ||
| }, | ||
| "role": { |
There was a problem hiding this comment.
"role" for id, and "Role" for title - a much too broad term.
please use a more narrow term.
i mean, if we ever have roles for services or something, you would call them "ServiceRoles", right?
Better not use these broad and general terms for things that are pretty narrow in their scope, this prevents extensions in the future and might lead to confusion.
Implements and closes #718