Regenerate markdown for each type defintion

pombredanne · pombredanne · commit 144214234ea9 · 2025-09-11T20:01:47.000+02:00
Based on the latest schema and JSON updates

Signed-off-by: Philippe Ombredanne &lt;pombredanne@aboutcode.org&gt;
diff --git a/types-doc/alpm-definition.md b/types-doc/alpm-definition.md
@@ -5,7 +5,7 @@ Do not manually edit this file. Edit the JSON type definition instead. -->
 
 - **Type Name:** Arch Linux package
 - **Description:** Arch Linux packages and other users of the libalpm/pacman package manager.
-- **Schema ID:** `https://packageurl.org/types/github-definition.json`
+- **Schema ID:** `https://packageurl.org/types/alpm-definition.json`
 
 ## PURL Syntax
 
@@ -28,11 +28,13 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Native Label:** name
 - **Note:** `The name is the package name. It is not case sensitive and must be lowercased.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Case Sensitive:** Yes
 - **Normalization rules:**
   - normalize version as specified in vercmp(8) at https://man.archlinux.org/man/vercmp.8#DESCRIPTION as part of alpm.
diff --git a/types-doc/apk-definition.md b/types-doc/apk-definition.md
@@ -5,7 +5,7 @@ Do not manually edit this file. Edit the JSON type definition instead. -->
 
 - **Type Name:** APK-based packages
 - **Description:** Alpine Linux APK-based packages
-- **Schema ID:** `https://packageurl.org/types/bitbucket-definition.json`
+- **Schema ID:** `https://packageurl.org/types/apk-definition.json`
 
 ## PURL Syntax
 
@@ -26,11 +26,13 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Native Label:** name
 - **Note:** `The name is the package name. It is not case sensitive and must be lowercased.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** version
 - **Note:** `The version is a package version as expected by apk.`
 
diff --git a/types-doc/bitbucket-definition.md b/types-doc/bitbucket-definition.md
@@ -26,11 +26,13 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Native Label:** repository name
 - **Note:** `The name is the repository name. It is not case sensitive and must be lowercased.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** commit or tag
 - **Note:** `The version is a commit or tag.`
 
diff --git a/types-doc/bitnami-definition.md b/types-doc/bitnami-definition.md
@@ -5,7 +5,7 @@ Do not manually edit this file. Edit the JSON type definition instead. -->
 
 - **Type Name:** Bitnami
 - **Description:** Bitnami-based packages
-- **Schema ID:** `https://packageurl.org/types/bitname-definition.json`
+- **Schema ID:** `https://packageurl.org/types/bitnami-definition.json`
 
 ## PURL Syntax
 
@@ -25,11 +25,13 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Native Label:** name
 - **Note:** `The name is the component name. It must be lowercased.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** full package version, including version and revision
 - **Note:** `The version is the full Bitnami package version, including version and revision.`
 
diff --git a/types-doc/cargo-definition.md b/types-doc/cargo-definition.md
@@ -25,11 +25,14 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
+- **Case Sensitive:** Yes
 - **Native Label:** name
 - **Note:** `The name is the repository name.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** version
 - **Note:** `The version is the package version.`
 
diff --git a/types-doc/cocoapods-definition.md b/types-doc/cocoapods-definition.md
@@ -25,17 +25,20 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Case Sensitive:** Yes
 - **Native Label:** pod name
 - **Note:** `The name is the pod name and is case sensitive, cannot contain whitespace, a plus (+) character, or begin with a period (.).`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** package version
 - **Note:** `The version is the package version.`
 
 ## Subpath definition
 
+- **Requirement:** Optional
 - **Note:** `The purl subpath is used to represent a pods subspec (if present).`
 
 ## Examples
diff --git a/types-doc/composer-definition.md b/types-doc/composer-definition.md
@@ -26,11 +26,13 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Native Label:** name
 - **Note:** `The name is not case sensitive and must be lowercased. Private, local packages may have no name. In this case you cannot create a purl for these.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** version
 
 ## Examples
diff --git a/types-doc/conan-definition.md b/types-doc/conan-definition.md
@@ -26,11 +26,13 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Native Label:** package-name
 - **Note:** `The Conan <package-name>.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** package-version
 - **Note:** `The Conan <package-version>.`
 
diff --git a/types-doc/conda-definition.md b/types-doc/conda-definition.md
@@ -25,11 +25,13 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Native Label:** name
 - **Note:** `The name is the package name.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** version
 - **Note:** `The version is the package version.`
 
diff --git a/types-doc/cpan-definition.md b/types-doc/cpan-definition.md
@@ -27,12 +27,14 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Case Sensitive:** Yes
 - **Native Label:** module or distribution name
 - **Note:** `The name is the module or distribution name and is case sensitive.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** version
 - **Note:** `The version is the module or distribution version.`
 
diff --git a/types-doc/cran-definition.md b/types-doc/cran-definition.md
@@ -25,11 +25,14 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
+- **Case Sensitive:** Yes
 - **Native Label:** name
 - **Note:** `The name is the package name and is case sensitive, but there cannot be two packages on CRAN with the same name ignoring case.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** version
 - **Note:** `The version is the package version.`
 
diff --git a/types-doc/deb-definition.md b/types-doc/deb-definition.md
@@ -26,11 +26,13 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Native Label:** name
 - **Note:** `The name is not case sensitive and must be lowercased.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** version
 - **Note:** `The version is the version of the binary (or source) package.`
 
diff --git a/types-doc/docker-definition.md b/types-doc/docker-definition.md
@@ -25,10 +25,12 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Native Label:** name
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Note:** `The version should be the image id sha256 or a tag. Since tags can be moved, a sha256 image id is preferred.`
 
 ## Examples
diff --git a/types-doc/gem-definition.md b/types-doc/gem-definition.md
@@ -5,7 +5,7 @@ Do not manually edit this file. Edit the JSON type definition instead. -->
 
 - **Type Name:** RubyGems
 - **Description:** RubyGems
-- **Schema ID:** `https://packageurl.org/types/generic-definition.json`
+- **Schema ID:** `https://packageurl.org/types/gem-definition.json`
 
 ## PURL Syntax
 
@@ -25,10 +25,12 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Native Label:** name
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** version
 
 ## Qualifiers Definition
diff --git a/types-doc/generic-definition.md b/types-doc/generic-definition.md
@@ -25,6 +25,7 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Note:** `as for other type, the name component is mandatory. In the worst case it can be a file or directory name.`
 
 ## Qualifiers Definition
diff --git a/types-doc/github-definition.md b/types-doc/github-definition.md
@@ -26,11 +26,13 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Native Label:** repository name
 - **Note:** `The name is the repository name. It is not case sensitive and must be lowercased.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** commit or tag
 - **Note:** `The version is a commit or tag.`
 
diff --git a/types-doc/golang-definition.md b/types-doc/golang-definition.md
@@ -25,14 +25,17 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Note:** `The name must be lowercased.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Note:** `The version is often empty when a commit is not specified and should be the commit in most cases when available.`
 
 ## Subpath definition
 
+- **Requirement:** Optional
 - **Note:** `The subpath is used to point to a subpath inside a package.`
 
 ## Examples
diff --git a/types-doc/hackage-definition.md b/types-doc/hackage-definition.md
@@ -25,6 +25,7 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Case Sensitive:** Yes
 - **Normalization rules:**
   - Apply kebab-case
@@ -33,6 +34,7 @@ The structure of a PURL for this package type is:
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** version
 - **Note:** `The version is package version.`
 
diff --git a/types-doc/hex-definition.md b/types-doc/hex-definition.md
@@ -26,11 +26,13 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Native Label:** name
 - **Note:** `The name is not case sensitive and must be lowercased.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** version
 
 ## Examples
diff --git a/types-doc/huggingface-definition.md b/types-doc/huggingface-definition.md
@@ -27,12 +27,14 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Case Sensitive:** Yes
 - **Native Label:** model repository name
 - **Note:** `The name is the model repository name. It is case sensitive.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** model revision Git commit hash
 - **Note:** `The version is the model revision Git commit hash. It is case insensitive and must be lowercased in the package URL.`
 
diff --git a/types-doc/luarocks-definition.md b/types-doc/luarocks-definition.md
@@ -25,11 +25,13 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Native Label:** name
 - **Note:** `The LuaRocks package name. It is case insensitive, but lowercase is encouraged since package names are normalized to ASCII lowercase.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Case Sensitive:** Yes
 - **Native Label:** full package version, including module version and rockspec revision
 - **Note:** `The full LuaRocks package version, including module version and rockspec revision. It is case sensitive, and lowercase must be used to avoid compatibility issues with older LuaRocks versions. The full version number is required to uniquely identify a version.`
diff --git a/types-doc/maven-definition.md b/types-doc/maven-definition.md
@@ -28,12 +28,14 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Case Sensitive:** Yes
 - **Native Label:** artifactId
 - **Note:** `The artifact id is the name.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Case Sensitive:** Yes
 - **Native Label:** version
 
diff --git a/types-doc/mlflow-definition.md b/types-doc/mlflow-definition.md
@@ -25,10 +25,12 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Note:** `The name is the model name. Case sensitivity depends on the server implementation, such as for Azure ML, it is case sensitive and must be kept as-is in the package URL; and for Databricks, it is case insensitive and must be lowercased in the package URL.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** version
 - **Note:** `The version is the model version.`
 
diff --git a/types-doc/npm-definition.md b/types-doc/npm-definition.md
@@ -27,11 +27,13 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Native Label:** name
 - **Note:** `Per the package.json spec, new package 'must not have uppercase letters in the name', therefore the name must be lowercased. The npm name used to be case sensitive in the early days for some old packages.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Case Sensitive:** Yes
 - **Native Label:** version
 
diff --git a/types-doc/nuget-definition.md b/types-doc/nuget-definition.md
@@ -25,12 +25,14 @@ The structure of a PURL for this package type is:
 
 ## Name definition
 
+- **Requirement:** Required
 - **Case Sensitive:** Yes
 - **Native Label:** version
 - **Note:** `Technically the name is case-perserving, but case-insensitive, and NuGet packages archives are case-perserving, while some NuGet API calls demand to lowercase the package name.`
 
 ## Version definition
 
+- **Requirement:** Optional
 - **Native Label:** version
 - **Note:** `The NuGet version is semver-like but may contain more than three segments`
 
diff --git a/types-doc/oci-definition.md b/types-doc/oci-definition.md
diff --git a/types-doc/pub-definition.md b/types-doc/pub-definition.md
diff --git a/types-doc/pypi-definition.md b/types-doc/pypi-definition.md
diff --git a/types-doc/qpkg-definition.md b/types-doc/qpkg-definition.md
diff --git a/types-doc/rpm-definition.md b/types-doc/rpm-definition.md
diff --git a/types-doc/swift-definition.md b/types-doc/swift-definition.md
