Namespace ABNF

- addresses review comments of #882
- update a few examples
- corrected "model" to "collection"

Author: tschmidtb51

docs/reference/code/namespaces.md

@@ -161,6 +161,8 @@ we expect that this will rarely lead to conflicts in practice.
     where a unregistered namespace is needed.
     The namespace `x_example.test#test` is recommended for use in testing of current or
     new SSVC related code.
+    The namespace `x_example.test#documentation` is recommended for use in documentation
+    or as examples.
 
  !!! tip "Test Namespace"
 
@@ -222,8 +224,8 @@ Subsequently, a `$` followed by a valid BCP 47 language tag ends the string.
 Note: If the `translation` uses just the reverse domain name followed by the language tag,
 e.g. `.example.test$de-DE`, this implies an unofficial translation done by the entity in possession of that
 domain name.
-A `translation` using an `x-name` indicates that the extension bases of a model that had a different language
-and no formal translation was used to develop that model.
+A `translation` using an `x-name` indicates that the extension bases of a collection that had a different language
+and no formal translation was used to develop that collection.
 The following diagram illustrates the structure of namespace extensions:
 
 ```mermaid
@@ -314,7 +316,7 @@ base_ns -->|/| first
 
     It is also different from `ssvc//.example.isao$pl-PL/example.isao#constituency` which
     denotes that the ISAO did a translation of the `ssvc` namespace to Polish and based
-    the model for their constituency on that translation.
+    the collection for their constituency on that translation.
 
 !!! example "Refinement of Concepts for a Specific Constituency"
 

src/ssvc/namespaces.py

@@ -58,6 +58,8 @@ class NameSpace(StrEnum):
     CVSS = auto()
     CISA = auto()
     BASIC = auto()
+    EXAMPLE = auto()
+    TEST = auto()
 
     @classmethod
     def validate(cls, value: str) -> str:

src/ssvc/utils/field_specs.py

@@ -47,7 +47,7 @@
         examples=[
             "ssvc",
             "cisa",
-            "x_example.test#test//.example.test#test",
+            "x_example.test#test//.example.test#private-extension",
             "ssvc/de-DE/.example.organization#reference-arch-1",
         ],
         pattern=NS_PATTERN,

src/test/test_namespaces_pattern.py

@@ -54,11 +54,11 @@ def setUp(self):
             "x_example.test.test#test/pl-PL/.example.test#another-collection/.org.example#a-different-collection/en-CA-newfound",  # valid BCP-47 tag and multiple segments
             "example.test",  # valid namespace with dots following reverse domain notation
             "x_example.test#test",  # valid namespace with x_ prefix and dots following reverse domain notation
-           "aa.example",  # valid namespace with dots following reverse domain notation for 2-letter TLD based on private use of ISO-3166
-            "x_au.com.example#bar"  # valid namespace with x_ prefix and dots following reverse domain notation
-            "abc//.example.test#test",
-            "abc//.com.au.example#test",
-            "abc//.example.test#test/.example.test#test",
+            "aa.example",  # valid namespace with dots following reverse domain notation for 2-letter TLD based on private use of ISO-3166
+            "x_aa.example#test"  # valid namespace with x_ prefix and dots following reverse domain notation
+            "test//.example.test#test",
+            "test//.com.au.example#test",
+            "example//.example.test#test/.example.some-other-org#foo",
             "foo.bar//.baz.quux#foo",
         ]
         self.expect_fail = [
@@ -67,6 +67,7 @@ def setUp(self):
             "x__invalid",  # invalid namespace, double underscore
             "x_-invalid",  # invalid namespace, dash after x_
             "x_.invalid",  # invalid namespace, dash at end
+            "x_invalid-",  # invalid namespace, dash at end
             "x_/foo",  # invalid namespace, slash after x_, invalid BCP-47 tag
             "x_//foo",  # invalid namespace, double slash after x_
             "x_abc/invalid-bcp-47",  # not a valid BCP-47 tag
@@ -104,7 +105,7 @@ def test_base_pattern(self):
             "contains-dash",
             "contains-dash-and.dot",
             "com.example",  # valid namespace with dots following reverse domain notation
-            "au.com.example",  # valid namespace with dots following reverse domain notation
+            "aa.com.example",  # valid namespace with dots following reverse domain notation
         ]
         x_fail = [
             "a",  # too short
@@ -137,7 +138,8 @@ def test_base_ns_pattern(self):
             "9abc",  # starts with a number
             "x__invalid",  # double underscore
             "x_-invalid",  # dash after x_
-            "x_.invalid",  # dash at end
+            "x_.invalid",  # dot at start
+            "x_invalid-",  # dash at end
             "x_9abc",  # starts with a number after x_
             "x_abc.",  # ends with a dot
             "x_abc-",  # ends with a dash