Skip to content

Commit 08d64ed

Browse files
committed
Add summary table
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
1 parent 634e967 commit 08d64ed

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

docs/standard/summary.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,19 @@ The definition for each components is:
2525
Optional.
2626

2727

28+
Table 1: Components of a PURL
29+
30+
| Component | Requirement | Description|
31+
| ---------- | ----------- |:------------------------------------------------------ |
32+
| scheme | Required | The URL scheme with the constant value of "pkg". One of the primary reasons for this single scheme is to facilitate the future official registration of the "pkg" scheme for package URLs. |
33+
| type | Required | The package "type" or package "protocol" such as maven, npm, nuget, gem, pypi, etc. |
34+
| namespace | Optional | A name prefix such as a Maven groupid, a Docker image owner, a GitHub user or organization. Namespace is type-specific. |
35+
| name | Required | The name of the package. |
36+
| version | Optional | The version of the package. |
37+
| qualifiers | Optional | Qualifier data for a package such as OS, architecture, repository, etc. Qualifiers are type-specific. |
38+
| subpath | Optional | Subpath within a package, relative to the package root. |
39+
40+
2841
Components are designed such that they form a hierarchy from the most significant
2942
on the left to the least significant components on the right.
3043

0 commit comments

Comments
 (0)