Skip to content
This repository has been archived by the owner on Aug 27, 2022. It is now read-only.

issue#10 #20

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
42 changes: 41 additions & 1 deletion modeling/model_configuration/classes.attributes.json
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,17 @@
"id": "3T-SBOM-EMS-Artifact-Document-referencedArtifacts",
"reverseName": "document"
},
{
"class": "Document",
"name": "referencedDocuments",
"description": "The elelement(s) capturing references to other documents, to be used for referenced artifacts, relationships, ...",
"type": "3T-SBOM-EMS-Artifact-ExternalDocumentRef",
"multiplicity": "*",
"aggregation": "shared",
"package": "Artifact",
"id": "3T-SBOM-EMS-Artifact-Document-referencedDocuments",
"reverseName": "document"
},
{
"class": "Document",
"name": "signature",
Expand All @@ -149,6 +160,35 @@
"id": "3T-SBOM-EMS-Artifact-Document-signature",
"reverseName": "document"
},
{
"class": "ExternalDocumentRef",
"name": "identifier",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Changing identifier -> externalDocumentId would make this compatible with SPDX

"description": "The identifier of the document, unique within the namespace.",
"type": "http://www.omg.org/spec/UML/20131001/PrimitiveTypes.xmi#String",
"multiplicity": "1",
"package": "Artifact",
"id": "3T-SBOM-EMS-Artifact-ExternalDocumentRef-identifier"
},
{
"class": "ExternalDocumentRef",
"name": "namespace",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just a note that this term is incompatible with SPDX which is spdxDocument. If this proposal is accepted, we should add an issue to SPDX 3.0 to change spdxDocument -> namespace.

"description": "The namespace of the identifier of the document.",
"type": "http://www.omg.org/spec/UML/20131001/PrimitiveTypes.xmi#String",
"multiplicity": "1",
"package": "Artifact",
"id": "3T-SBOM-EMS-Artifact-ExternalDocumentRef-namespace"
},
{
"class": "ExternalDocumentRef",
"name": "signature",
"description": "The elelement capturing the optional signature of the document.",
"type": "3T-SBOM-EMS-Artifact-Signature",
"multiplicity": "0..1",
"aggregation": "composite",
"package": "Artifact",
"id": "3T-SBOM-EMS-Artifact-ExternalDocumentRef-signature",
"reverseName": "document"
},
{
"class": "AbstractArtifact",
Copy link
Collaborator

Choose a reason for hiding this comment

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

propose adding one more field checksum with a type 3T-...Checksum and a multiplicity of 0..1. 2 reasons to add - checksums are much easier to generate than signatures and it would be compatible with SPDX.

"name": "name",
Expand Down Expand Up @@ -234,7 +274,7 @@
"class": "ReferencedArtifact",
"name": "referenceDocument",
"description": "Reference to documents that detail the referenced artifact.",
"type": "3T-SBOM-EMS-Artifact-Document",
"type": "3T-SBOM-EMS-Artifact-AbstractDocument",
"multiplicity": "*",
"package": "Artifact",
"id": "3T-SBOM-EMS-Artifact-ReferencedArtifact-referenceDocument"
Expand Down
23 changes: 22 additions & 1 deletion modeling/model_configuration/classes.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,36 @@
"id": "3T-SBOM-EMS-Artifact-Element"
},
{
"name": "Document",
"name": "AbstractDocument",
"package": "Artifact",
"generalization": "Element",
"description": "This class is the abstract parent of all the classes representing the Software Bill of Material document:",
"compositionDescription": [
"The document themselves,",
"The references to external documents."],
"id": "3T-SBOM-EMS-Artifact-AbstractDocument"
},
{
"name": "Document",
"package": "Artifact",
"generalization": "AbstractDocument",
"description": "This class represents the Software Bill of Material document. Its function is dual:",
"compositionDescription": [
"Clearly identify the piece of software under consideration,",
"Be referenced to attach additional pieces of information pertaining to the considered piece of software."],
"id": "3T-SBOM-EMS-Artifact-Document"
},
{
"name": "ExternalDocumentRef",
"package": "Artifact",
"generalization": "AbstractDocument",
"description": "This class represents references to external Software Bill of Material documents. They can be needed:",
"compositionDescription": [
"To hint at documents detailing ReferencedArtifact elements,",
"To be used in Relationship elements,",
"..."],
"id": "3T-SBOM-EMS-Artifact-ExternalDocumentRef"
},
{
"name": "AbstractArtifact",
"package": "Artifact",
Expand Down