Skip to content

Namespaces: Also Mention ":" as Namespace Delimiter #60

Description

@gregweb

I very like the specification proposes to add namespaces.
As followed my proposed minor addition to the spec.

Current

Namespace delimiter examples are "." or "/".

Spec sections:

  • "4.6.1. Extension Keys":
    • "SHOULD include a delimiter (e.g. . or /) separating the namespace from the identifier"
    • "The ctrf. and ctrf/ namespace prefixes are reserved for CTRF-defined extensions.
      Producers other than CTRF MUST NOT use extension keys beginning with ctrf. or ctrf/."
  • "D.6. CTRF Document with Namespaced Extra Objects"

Proposed change

  • under section "4.6.1. Extension Keys" also add ":" to the example delimiters
    • "SHOULD include a delimiter (e.g. . or / or :) separating the namespace from the identifier"
    • "The ctrf., ctrf/ and ctrf: namespace prefixes are reserved for CTRF-defined extensions.
      Producers other than CTRF MUST NOT use extension keys beginning with ctrf., ctrf/ or ctrf:"
  • under section "D.6. CTRF Document with Namespaced Extra Objects" add the following or similar:
    To express at top level that a key is namespace key as opposed to a non-namespace key, the namespace delimiter MAY be appended to the namespace key. Example (with : namespace delimiter)
"extra": {
    "myorg.ci:": {     // mind the trailing ":"
        "pipeline": {
        }
    }
}

An Addtional Idea

It may make sense to specify at top level which namespace delimiter is used within the document:

5.10. namespaceDelimiter [or nsDelimiter]

Description:
Identifies the namespace delimiter used in this report.

Requirements:
namespaceDelimiter is OPTIONAL.
If present, it MUST be a non-empty string.
[I initially thought to restrict the string to a length of one.]

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions