Add meta.document.name and .namespace (#105)

* Add meta.document.name and .namespace

Signed-off-by: Simon Heimler <simon.heimler@sap.com>

* Bump version to 1.0.7

Signed-off-by: Simon Heimler <simon.heimler@sap.com>

* Update description

Signed-off-by: Simon Heimler <simon.heimler@sap.com>

* Run prettier

Signed-off-by: Simon Heimler <simon.heimler@sap.com>

* Update example

Signed-off-by: Simon Heimler <simon.heimler@sap.com>

* Undo version bump

Signed-off-by: Simon Heimler <simon.heimler@sap.com>

* Undo version bump in changelog

Signed-off-by: Simon Heimler <simon.heimler@sap.com>

---------

Signed-off-by: Simon Heimler <simon.heimler@sap.com>

Author: Fannon

CHANGELOG.md

@@ -12,6 +12,8 @@ For a roadmap including expected timeline, please refer to [ROADMAP.md](./ROADMA
 
 ### Added
 
+- Added `meta.document.name` to give the overall document a machine-readable name
+- Added `meta.document.namespace` to give the overall document a globally unique namespace
 - Allow `cds.Decimal` to be used as a key, indicated via `key` boolean
 
 ## [1.0.6]

package.json

@@ -34,6 +34,7 @@
     "lint:staged": "lint-staged",
     "eslint": "eslint . --fix",
     "eslint:ci": "eslint .",
+    "format": "npm run prettier",
     "prettier": "prettier --write \"**/*.{json,yml,yaml,md}\"",
     "prettier:ci": "prettier --check \"**/*.{json,yml,yaml,md}\"",
     "test": "npm run build && npm run test:unit",

spec/v1/CSN-Interop-Effective.schema.yaml

@@ -167,6 +167,26 @@ definitions:
     description: |-
       Metadata that describes the document (and what it represents) itself.
     properties:
+      name:
+        type: string
+        maxLength: 255
+        description: |-
+          Machine readable technical name / local ID of the CSN document.
+          Together with `meta.document.namespace` and `meta.document.version` it uniquely identifies the CSN document at a given version.
+
+          MUST NOT contain linebreaks.
+          MUST be unique across all CSN documents in the same `meta.document.namespace`.
+        pattern: '^([a-zA-Z0-9._\-]+)$'
+
+      namespace:
+        type: string
+        maxLength: 36
+        description: |-
+          Globally unique namespace of the CSN document.
+          Together with `meta.document.name` and `meta.document.version` it uniquely identifies the CSN document at a given version.
+
+          MUST be a valid, registered [ORD namespace](https://open-resource-discovery.github.io/specification/spec-v1#namespaces) with at least two fragments.
+        pattern: "^[a-z0-9]+(?:[.][a-z0-9]+){1,}$"
       version:
         type: string
         description: |-
@@ -188,6 +208,7 @@ definitions:
           Human readable documentation that describes the overall CSN document.
 
           SHOULD be provided and interpreted as [CommonMark](https://spec.commonmark.org/) (Markdown).
+
     additionalProperties: false
 
   MetaFeatures:

spec/v1/examples/airline.json

@@ -6,6 +6,8 @@
     "document": {
       "version": "1.2.3",
       "title": "Airline (Example)",
+      "name": "Airline",
+      "namespace": "sap.xref",
       "doc": "This CSN example document shows how the airline example is expressed with a CDS **Service** exposing the entities through an API."
     },
     "features": {

src/generated/spec-v1/schemas/csn-interop-effective.schema.json

@@ -128,6 +128,18 @@
       "type": "object",
       "description": "Metadata that describes the document (and what it represents) itself.",
       "properties": {
+        "name": {
+          "type": "string",
+          "maxLength": 255,
+          "description": "Machine readable technical name / local ID of the CSN document.\nTogether with `meta.document.namespace` and `meta.document.version` it uniquely identifies the CSN document at a given version.\n\nMUST NOT contain linebreaks.\nMUST be unique across all CSN documents in the same `meta.document.namespace`.",
+          "pattern": "^([a-zA-Z0-9._\\-]+)$"
+        },
+        "namespace": {
+          "type": "string",
+          "maxLength": 36,
+          "description": "Globally unique namespace of the CSN document.\nTogether with `meta.document.name` and `meta.document.version` it uniquely identifies the CSN document at a given version.\n\nMUST be a valid, registered [ORD namespace](https://open-resource-discovery.github.io/specification/spec-v1#namespaces) with at least two fragments.",
+          "pattern": "^[a-z0-9]+(?:[.][a-z0-9]+){1,}$"
+        },
         "version": {
           "type": "string",
           "description": "The version of the CSN document / the described model itself (not the specification).\n\nWe RECOMMEND to use the [SemVer](https://semver.org/) standard.",

src/generated/spec-v1/types/csn-interop-effective.ts

@@ -442,6 +442,21 @@ export interface Meta {
  * Metadata that describes the document (and what it represents) itself.
  */
 export interface DocumentMetadata {
+  /**
+   * Machine readable technical name / local ID of the CSN document.
+   * Together with `meta.document.namespace` and `meta.document.version` it uniquely identifies the CSN document at a given version.
+   *
+   * MUST NOT contain linebreaks.
+   * MUST be unique across all CSN documents in the same `meta.document.namespace`.
+   */
+  name?: string;
+  /**
+   * Globally unique namespace of the CSN document.
+   * Together with `meta.document.name` and `meta.document.version` it uniquely identifies the CSN document at a given version.
+   *
+   * MUST be a valid, registered [ORD namespace](https://open-resource-discovery.github.io/specification/spec-v1#namespaces) with at least two fragments.
+   */
+  namespace?: string;
   /**
    * The version of the CSN document / the described model itself (not the specification).
    *