Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 2 additions & 43 deletions schema/2.0/modules/cyclonedx-annotation-2.0.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,50 +39,9 @@
"description": "The object in the BOM identified by its `refId`. This is often a component or service, but may be any object type supporting `refId`s."
},
"annotator": {
"type": "object",
"title": "Annotator",
"description": "The organization, person, or component which created the textual content of the annotation.",
"oneOf": [
{
"required": [
"organization"
],
"properties": {
"organization": true
}
},
{
"required": [
"individual"
],
"properties": {
"individual": true
}
},
{
"required": [
"component"
],
"properties": {
"component": true
}
}
],
"additionalProperties": false,
"properties": {
"organization": {
"description": "The organization that created the annotation.",
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/organizationalEntity"
},
"individual": {
"description": "The person that created the annotation.",
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/organizationalContact"
},
"component": {
"description": "The tool or component that created the annotation.",
"$ref": "cyclonedx-component-2.0.schema.json#/$defs/componentEntry"
}
}
"description": "The organization, person, or component which created the textual content of the annotation. TODO: do we want an new role `annotator`??? The party's `roles` should include `\"annotator\"`.",
"$ref": "cyclonedx-party-2.0.schema.json#/$defs/partyChoice"
},
"timestamp": {
"type": "string",
Expand Down
100 changes: 4 additions & 96 deletions schema/2.0/modules/cyclonedx-common-2.0.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -363,88 +363,6 @@
}
}
},
"organizationalEntity": {
"type": "object",
"title": "Organizational Entity",
"additionalProperties": false,
"properties": {
"refId": {
"$ref": "#/$defs/refIdType",
"title": "Reference Identifier",
"description": "An identifier which can be used to reference the object elsewhere in the document. Every `refId` shall be unique within the document."
},
"name": {
"type": "string",
"title": "Organization Name",
"description": "The name of the organization.",
"examples": [
"Example Inc."
]
},
"address": {
"$ref": "#/$defs/postalAddress",
"title": "Organization Address",
"description": "The physical address (location) of the organization."
},
"url": {
"type": "array",
"items": {
"type": "string",
"format": "iri-reference"
},
"title": "Organization URL(s)",
"description": "The URL of the organization. Multiple URLs are allowed.",
"examples": ["https://example.com"]
},
"contact": {
"type": "array",
"title": "Organizational Contact",
"description": "A contact at the organization. Multiple contacts are allowed.",
"items": {"$ref": "#/$defs/organizationalContact"}
},
"origins": {
"type": "array",
"title": "Organization Origins",
"description": "The geographic origins associated with the organization, such as the country or countries where its goods or services originate. Multiple origins are allowed, each calculated on a different basis.",
"minItems": 1,
"items": {"$ref": "#/$defs/origin"}
}
}
},
"organizationalContact": {
"type": "object",
"title": "Organizational Contact",
"additionalProperties": false,
"properties": {
"refId": {
"$ref": "#/$defs/refIdType",
"title": "Reference Identifier",
"description": "An identifier which can be used to reference the object elsewhere in the document. Every `refId` shall be unique within the document."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of a contact.",
"examples": ["Contact name"]
},
"email": {
"type": "string",
"format": "idn-email",
"title": "Email Address",
"description": "The email address of the contact.",
"examples": ["firstname.lastname@example.com"]
},
"phone": {
"type": "string",
"title": "Phone",
"description": "The phone number of the contact.",
"examples": ["800-555-1212"]
}
}
},
"organizationalEntityOrContact": {
"$comment": "TODO"
},
"origin": {
"type": "object",
"title": "Origin",
Expand Down Expand Up @@ -790,12 +708,12 @@
},
"author": {
"title": "Author",
"description": "The author who created the changes in the commit.",
"description": "The author(s) who created the changes in the commit. The `actor`'s `roles` should include `\"author\"`",
"$ref": "#/$defs/identifiableAction"
},
"committer": {
"title": "Committer",
"description": "The person who committed or pushed the commit.",
"description": "The party who committed or pushed the commit. The `actor`'s `roles` should include `\"committer\"`",
"$ref": "#/$defs/identifiableAction"
},
"message": {
Expand Down Expand Up @@ -989,7 +907,7 @@
"identifiableAction": {
"type": "object",
"title": "Identifiable Action",
"description": "Specifies an individual commit.",
"description": "Specifies an individual action.",
"additionalProperties": false,
"properties": {
"timestamp": {
Expand All @@ -998,17 +916,7 @@
"title": "Timestamp",
"description": "The timestamp in which the action occurred."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the individual who performed the action."
},
"email": {
"type": "string",
"format": "idn-email",
"title": "E-mail",
"description": "The email address of the individual who performed the action."
}
"actor": { "$ref": "cyclonedx-party-2.0.schema.json#/$defs/partyChoice" }
}
},
"locale": {
Expand Down
21 changes: 7 additions & 14 deletions schema/2.0/modules/cyclonedx-declaration-2.0.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,16 @@
"items": {
"type": "object",
"title": "Assessor",
"description": "The assessor who evaluates claims and determines conformance to requirements and confidence in that assessment.",
"description": "The assessor who evaluates claims and determines conformance to requirements and confidence in that assessment. The party's `roles` should include `\"???\"`.",
"additionalProperties": false,
"properties": {
"refId": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refIdType",
"title": "Reference Identifier",
"description": "An identifier which can be used to reference the object elsewhere in the document. Every `refId` shall be unique within the document."
"actor": {
"$ref": "cyclonedx-party-2.0.schema.json#/$defs/partyChoice"
},
"thirdParty": {
"type": "boolean",
"title": "Third Party",
"description": "The boolean indicating if the assessor is outside the organization generating claims. A value of `false` indicates a self assessor."
},
"organization": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/organizationalEntity",
"title": "Organization",
"description": "The entity issuing the assessment."
}
}
}
Expand Down Expand Up @@ -269,14 +262,14 @@
"description": "The date and time (timestamp) when the evidence is no longer valid."
},
"author": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/organizationalContact",
"$ref": "cyclonedx-party-2.0.schema.json#/$defs/partyChoice",
"title": "Author",
"description": "The author of the evidence."
"description": "The author of the evidence. The party's `roles` should include `\"???\"`."
},
"reviewer": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/organizationalContact",
"$ref": "cyclonedx-party-2.0.schema.json#/$defs/partyChoice",
"title": "Reviewer",
"description": "The reviewer of the evidence."
"description": "The reviewer of the evidence. The party's `roles` should include `\"???\"`."
},
"signatures": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/signatures"
Expand Down
8 changes: 4 additions & 4 deletions schema/2.0/modules/cyclonedx-metadata-2.0.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@
},
"manufacturer": {
"title": "BOM Manufacturer",
"description": "The organization that created the BOM.\nManufacturer is common in BOMs created through automated processes. BOMs created through manual means may have `authors` instead.",
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/organizationalEntity"
"description": "The party that created the BOM. The party's `roles` should include `\"manufacturer\"`.\nManufacturer is common in BOMs created through automated processes. BOMs created through manual means may have `authors` instead.",
"$ref": "cyclonedx-party-2.0.schema.json#/$defs/partyChoice"
},
"authors": {
"type": "array",
"title": "BOM Authors",
"description": "The person(s) who created the BOM.\nAuthors are common in BOMs created through manual processes. BOMs created through automated means may have `manufacturer` instead.",
"items": {"$ref": "cyclonedx-common-2.0.schema.json#/$defs/organizationalContact"}
"description": "The parties that created the BOM. The party's `roles` should include `\"author\"`.\nAuthors are common in BOMs created through manual processes. BOMs created through automated means may have `manufacturer` instead.",
"items": { "$ref": "cyclonedx-party-2.0.schema.json#/$defs/partyChoice" }
},
"licenses": {
"title": "BOM License(s)",
Expand Down
Loading