Merge pull request package-url#666 from package-url/ecma-fixes-2

ECMA changes and corrections

Author: pombredanne

docs/standard/characters-and-encoding.md

@@ -1,6 +1,6 @@
 ## Permitted characters
 
-A canonical `purl` is composed of these permitted ASCII characters:
+A canonical PURL is composed of these permitted ASCII characters:
 
 - the Alphanumeric Characters: `A to Z`, `a to z`, `0 to 9`,
 - the Punctuation Characters: `.-_~` (period '.',
@@ -23,11 +23,11 @@ This is how each of the Separator Characters is used:
   `qualifier`
 - '&' (ampersand) is the separator between `qualifiers` (each being a
   `key=value` pair)
-- '#' (number sign) is the separator before `subpath`
+- '#' (hash sign) is the separator before `subpath`
 
 ## Character encoding
 
-- In the "Rules for each `purl` component" section, each component
+- In the "Rules for each PURL component" section, each component
   defines when and how to apply percent-encoding and decoding to its content.
 - When percent-encoding is required by a component definition, the component
   string must first be encoded as UTF-8.
@@ -45,7 +45,7 @@ This is how each of the Separator Characters is used:
 
   - the Alphanumeric Characters,
   - the Punctuation Characters,
-  - the Separator Characters when being used as `purl` separators,
+  - the Separator Characters when being used as PURL separators,
   - the colon ':', whether used as a Separator Character or otherwise, and
   - the percent sign '%' when used to represent a percent-encoded character.
 

docs/standard/components.md

@@ -1,6 +1,6 @@
-## Rules for each `purl` component
+## Rules for each PURL component
 
-A `purl` string is an ASCII URL string composed of seven components.
+A PURL string is an ASCII URL string composed of seven components.
 
 Except as expressly stated otherwise in this section, each component:
 
@@ -15,7 +15,7 @@ The rules for each component are:
 
   - The `scheme` is a constant with the value "pkg".
   - The `scheme` must be followed by an unencoded colon ':'.
-  - `purl` parsers must accept URLs where the `scheme` and colon ':' are
+  - PURL parsers must accept URLs where the `scheme` and colon ':' are
     followed by one or more slash '/' characters, such as 'pkg://', and must
     ignore and remove all such '/' characters.
 
@@ -99,7 +99,7 @@ The rules for each component are:
 
 - **subpath**:
   - The `subpath` string is prefixed by a '#' separator when not empty
-  - This '#' is not part of the `subpath`
+  - The '#' is not part of the `subpath`
   - The `subpath` contains zero or more segments, separated by slash '/'
   - Leading and trailing slashes '/' are not significant and should be stripped
     in the canonical form

docs/standard/references.md

@@ -4,9 +4,17 @@ The following referenced documents are indispensable for the application of this
 For dated references, only the edition cited applies. For undated references, the latest
 edition of the referenced document (including any amendments) applies.
 
-ASCII, *American National Standards Institute, "Coded Character Set -- 7-bit American
-Standard Code for Information Interchange", ANSI X3.4, 1986*
-https://en.wikipedia.org/wiki/ASCII
+INCITS 4-1986 [R2022], *Information Systems - Coded Character Sets - 7-Bit Standard Code for Information Interchange (7-Bit ASCII)*.
+[https://webstore.ansi.org/standards/incits/incits1986r2022](https://webstore.ansi.org/standards/incits/incits1986r2022)
 
-RFC 3986, ​*Uniform Resource Identifier (URI): Generic Syntax*​.
+RFC 3986, *Uniform Resource Identifier (URI): Generic Syntax*.
 [https://datatracker.ietf.org/doc/html/rfc3986](https://datatracker.ietf.org/doc/html/rfc3986)
+
+The Unicode Standard.
+[https://www.unicode.org/versions/latest/](https://www.unicode.org/versions/latest/)
+
+ECMA-404, *The JSON Data Interchange Format*.
+[https://www.ecma-international.org/publications-and-standards/standards/ecma-404/](https://www.ecma-international.org/publications-and-standards/standards/ecma-404/)
+
+IETF Draft, March 2018, *JSON Schema Validation: A Vocabulary for Structural Validation of JSON (Draft-07)*.
+[https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-validation-01](https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-validation-01)

docs/standard/summary.md

@@ -1,30 +1,13 @@
-## What is a `purl`?
+## What is a PURL
 
-`purl` stands for **package URL**.
+PURL stands for **package URL**.
 
-A `purl` is a URL composed of seven components:
+A PURL is a URL composed of seven components:
 
     scheme:type/namespace/name@version?qualifiers#subpath
 
 Components are separated by a specific character for unambiguous parsing.
 
-The definition for each component is:
-
-- **scheme**: this is the URL scheme with the constant value of "pkg". One of
-  the primary reason for this single scheme is to facilitate the future official
-  registration of the "pkg" scheme for package URLs. Required.
-- **type**: the package "type" or package "protocol" such as maven, npm, nuget,
-  gem, pypi, etc. Required.
-- **namespace**: some name prefix such as a Maven groupid, a Docker image owner,
-  a GitHub user or organization. Optional and type-specific.
-- **name**: the name of the package. Required.
-- **version**: the version of the package. Optional.
-- **qualifiers**: extra qualifying data for a package such as an OS,
-  architecture, a distro, etc. Optional and type-specific.
-- **subpath**: extra subpath within a package, relative to the package root.
-  Optional.
-
-
 Table 1: Components of a PURL
 
 | Component  | Requirement | Description|
@@ -42,12 +25,12 @@ Components are designed such that they form a hierarchy from the most significan
 on the left to the least significant components on the right.
 
 
-A `purl` must not contain a URL Authority, i.e. there is no support for
+A PURL must not contain a URL Authority, i.e. there is no support for
 `username`, `password`, `host` and `port` components. A `namespace` segment may
 sometimes look like a `host`, but its interpretation is specific to a `type`.
 
 
-## Some `purl` examples
+## Some PURL examples
 
     pkg:bitbucket/birkenfeld/pygments-main@244fd47e07d1014f0aed9c
     pkg:deb/debian/curl@7.50.3-1?arch=i386&distro=jessie
@@ -61,9 +44,9 @@ sometimes look like a `host`, but its interpretation is specific to a `type`.
     pkg:rpm/fedora/curl@7.50.3-1.fc25?arch=i386&distro=fedora-25
 
 
-## A `purl` is a URL
+## A PURL is a URL
 
-- A `purl` is a valid URL and URI that conforms to the URL definitions or
+- A PURL is a valid URL and URI that conforms to the URL definitions or
   specifications at:
 
   - https://tools.ietf.org/html/rfc3986
@@ -74,25 +57,25 @@ sometimes look like a `host`, but its interpretation is specific to a `type`.
 - This is a valid URL because it is a locator even though it has no Authority
   URL component: each `type` has a default repository location when defined.
 
-- The `purl` components are mapped to these URL components:
+- The PURL components are mapped to these URL components:
 
-  - `purl` `scheme`: this is a URL `scheme` with a constant value: `pkg`
-  - `purl` `type`, `namespace`, `name` and `version` components: these are
+  - PURL `scheme`: this is a URL `scheme` with a constant value: `pkg`
+  - PURL `type`, `namespace`, `name` and `version` components: these are
     collectively mapped to a URL `path`
-  - `purl` `qualifiers`: this maps to a URL `query`
-  - `purl` `subpath`: this is a URL `fragment`
-  - In a `purl`, there is no support for a URL Authority (e.g. no
+  - PURL `qualifiers`: this maps to a URL `query`
+  - PURL `subpath`: this is a URL `fragment`
+  - In a PURL, there is no support for a URL Authority (e.g. no
     `username`, `password`, `host` and `port` components).
 
 - Special URL schemes as defined in https://url.spec.whatwg.org/ such as
-  `file://`, `https://`, `http://` and `ftp://` are not valid `purl` types.
-  They are valid URL or URI schemes but they are not `purl`.
-  They may be used to reference URLs in separate attributes outside of a `purl`
-  or in a `purl` qualifier.
+  `file://`, `https://`, `http://` and `ftp://` are not valid PURL types.
+  They are valid URL or URI schemes but they are not PURL.
+  They may be used to reference URLs in separate attributes outside of a PURL
+  or in a PURL qualifier.
 
 - Version control system (VCS) URLs such `git://`, `svn://`, `hg://` or as
-  defined in Python pip or SPDX download locations are not valid `purl` types.
-  They are valid URL or URI schemes but they are not `purl`.
+  defined in Python pip or SPDX download locations are not valid PURL types.
+  They are valid URL or URI schemes but they are not PURL.
   They are a closely related, compact and uniform way to reference VCS URLs.
-  They may be used as references in separate attributes outside of a `purl` or
-  in a `purl` qualifier.
+  They may be used as references in separate attributes outside of a PURL or
+  in a PURL qualifier.

docs/standard/types.md

@@ -1,13 +1,13 @@
-## Package-URL Type definitions
+## Package-URL type definitions
 
 Each package manager, platform, type, or ecosystem has its own conventions
 and protocols to identify, locate, and provision software packages.
 
 The package **type** is the component of a Package-URL that is used to
-capture this information with a short string such as ``maven``, ``npm``,
-``nuget``, ``gem``, ``pypi``, etc.
+capture this information with a short string such as `maven`, `npm`,
+`nuget`, `gem`, `pypi`, etc.
 
-These are registered ``PURL`` package type definitions.
+These are registered PURL package type definitions.
 
 Definitions can also include types reserved for future use.
 

schemas/purl-type-definition.schema.json

@@ -24,11 +24,13 @@
     "optional_requirement": {
       "title": "Component optional requirement",
       "description": "States that this PURL component is optional for a PURL type.",
+      "type": "string",
       "constant": "optional"
     },
     "required_requirement": {
       "title": "Component required requirement",
       "description": "States that this PURL component is required for a PURL type.",
+      "type": "string",
       "constant": "required"
     },
     "purl_component_definition": {