Current section

Files

Jump to
purl priv spec types swid-definition.json
Raw

priv/spec/types/swid-definition.json

{
"$schema": "https://packageurl.org/schemas/purl-type-definition.schema-1.0.json",
"$id": "https://packageurl.org/types/swid-definition.json",
"type": "swid",
"type_name": "Software Identification (SWID) Tag",
"description": "PURL type for ISO-IEC 19770-2 Software Identification (SWID) tags.",
"repository": {
"use_repository": false,
"note": "There is no default package repository."
},
"namespace_definition": {
"requirement": "optional",
"case_sensitive": true,
"native_name": "softwareCreator",
"note": "The namespace is the optional name and regid of the entity with a role of softwareCreator. If specified, name is required and is the first segment in the namespace. If regid is known, it must be specified as the second segment in the namespace. A maximum of two segments are supported."
},
"name_definition": {
"requirement": "required",
"case_sensitive": true,
"native_name": "SoftwareIdentity/name",
"note": "The name is the name as defined in the SWID SoftwareIdentity element."
},
"version_definition": {
"requirement": "optional",
"case_sensitive": true,
"native_name": "SoftwareIdentity/version",
"note": "The version is the version as defined in the SWID SoftwareIdentity element."
},
"qualifiers_definition": [
{
"key": "tag_id",
"requirement": "required",
"description": "The qualifier tag_id must not be empty and corresponds to the tagId as defined in the SWID SoftwareIdentity element. Per the SWID specification, GUIDs are recommended. If a GUID is used, it must be lowercase. If a GUID is not used, the tag_id qualifier is case aware but not case sensitive."
},
{
"key": "tag_version",
"requirement": "optional",
"description": "The qualifier tag_version is an optional integer and corresponds to the tagVersion as defined in the SWID SoftwareIdentity element. If not specified, defaults to 0."
},
{
"key": "patch",
"requirement": "optional",
"description": "The qualifier patch is optional and corresponds to the patch as defined in the SWID SoftwareIdentity element. If not specified, defaults to false."
},
{
"key": "tag_creator_name",
"requirement": "optional",
"description": "The qualifier tag_creator_name is optional. If the tag creator is different from the software creator, the tag_creator_name qualifier should be specified."
},
{
"key": "tag_creator_regid",
"requirement": "optional",
"description": "The qualifier tag_creator_regid is optional. If the tag creator is different from the software creator, the tag_creator_regid qualifier should be specified."
}
],
"note": "Use of known qualifiers key/value pairs such as download_url can be used to specify where the package was retrieved from.",
"examples": [
"pkg:swid/Acme/example.com/Enterprise+Server@1.0.0?tag_id=75b8c285-fa7b-485b-b199-4745e3004d0d",
"pkg:swid/Fedora@29?tag_id=org.fedoraproject.Fedora-29",
"pkg:swid/Adobe%2BSystems%2BIncorporated/Adobe%2BInDesign@CC?tag_id=CreativeCloud-CS6-Win-GM-MUL"
]
}