works on local metaschema proc build

ga4gh · Sep 8, 2023 · bd21446 · bd21446
1 parent 4878a91
commit bd21446
Show file tree

Hide file tree

Showing 26 changed files with 1,798 additions and 799 deletions.
diff --git a/schema/core-source.yaml b/schema/core-source.yaml
@@ -33,8 +33,8 @@ $defs:
       propertyName: type
 
   MappableEntity:
-    type: object
     inherits: Entity
+    description: an Entity that is mappable to codings in other terminology systems.
     heritableProperties:
       mappings:
         type: array

diff --git a/schema/core.json b/schema/core.json
@@ -13,7 +13,12 @@
                "description": "The 'logical' identifier of the entity in the system of record, e.g. a UUID. This 'id' is  unique within a given system. The identified entity may have a different 'id' in a different  system, or may refer to an 'id' for the shared concept in another system (e.g. a CURIE)."
             },
             "label": {
-               "type": "string"
+               "type": "string",
+               "description": "A primary label for the entity."
+            },
+            "description": {
+               "type": "string",
+               "description": "A free-text description of the entity."
             },
             "extensions": {
                "type": "array",
@@ -34,8 +39,8 @@
                "$ref": "#/$defs/Code",
                "description": "Symbol in syntax defined by the terminology system."
             },
-            "mapping": {
-               "description": "A mapping between concepts as defined by the Simple Knowledge Organization System (SKOS).",
+            "relation": {
+               "description": "A mapping relation between concepts as defined by the Simple Knowledge Organization System (SKOS).",
                "type": "string",
                "enum": [
                   "closeMatch",
@@ -48,7 +53,7 @@
          },
          "required": [
             "code",
-            "mapping",
+            "relation",
             "system"
          ],
          "additionalProperties": false

diff --git a/schema/core.yaml b/schema/core.yaml
@@ -15,6 +15,10 @@ $defs:
           an 'id' for the shared concept in another system (e.g. a CURIE).
       label:
         type: string
+        description: A primary label for the entity.
+      description:
+        type: string
+        description: A free-text description of the entity.
       extensions:
         type: array
         ordered: true
@@ -29,9 +33,9 @@ $defs:
       code:
         $ref: '#/$defs/Code'
         description: Symbol in syntax defined by the terminology system.
-      mapping:
-        description: A mapping between concepts as defined by the Simple Knowledge
-          Organization System (SKOS).
+      relation:
+        description: A mapping relation between concepts as defined by the Simple
+          Knowledge Organization System (SKOS).
         type: string
         enum:
         - closeMatch
@@ -41,7 +45,7 @@ $defs:
         - relatedMatch
     required:
     - code
-    - mapping
+    - relation
     - system
     additionalProperties: false
   Extension:

diff --git a/schema/defs/core/Entity.rst b/schema/defs/core/Entity.rst
@@ -2,27 +2,31 @@
 
 Entity is the root class of ‘core’ classes model - those that have identifiers and other general  metadata like labels, xrefs, urls, descriptions, etc. All core classes descend from and inherit  its attributes.
 
-**Information Model**
-
-.. list-table::
-   :class: clean-wrap
-   :header-rows: 1
-   :align: left
-   :widths: auto
-
-   *  - Field
-      - Type
-      - Limits
-      - Description
-   *  - id
-      - string
-      - 0..1
-      - The 'logical' identifier of the entity in the system of record, e.g. a UUID. This 'id' is  unique within a given system. The identified entity may have a different 'id' in a different  system, or may refer to an 'id' for the shared concept in another system (e.g. a CURIE).
-   *  - label
-      - string
-      - 0..1
-      - 
-   *  - extensions
-      - :ref:`Extension`
-      - 0..m
-      - 
+    **Information Model**
+
+    .. list-table::
+       :class: clean-wrap
+       :header-rows: 1
+       :align: left
+       :widths: auto
+
+       *  - Field
+          - Type
+          - Limits
+          - Description
+       *  - id
+          - string
+          - 0..1
+          - The 'logical' identifier of the entity in the system of record, e.g. a UUID. This 'id' is  unique within a given system. The identified entity may have a different 'id' in a different  system, or may refer to an 'id' for the shared concept in another system (e.g. a CURIE).
+       *  - label
+          - string
+          - 0..1
+          - A primary label for the entity.
+       *  - description
+          - string
+          - 0..1
+          - A free-text description of the entity.
+       *  - extensions
+          - :ref:`Extension`
+          - 0..m
+          - 
diff --git a/schema/defs/core/Extension.rst b/schema/defs/core/Extension.rst
@@ -2,27 +2,27 @@
 
 The Extension class provides VODs with a means to extend descriptions with other attributes unique to a content provider. These extensions are not expected to be natively understood under VRSATILE, but may be used for pre-negotiated exchange of message attributes when needed.
 
-**Information Model**
-
-.. list-table::
-   :class: clean-wrap
-   :header-rows: 1
-   :align: left
-   :widths: auto
-
-   *  - Field
-      - Type
-      - Limits
-      - Description
-   *  - type
-      - string
-      - 0..1
-      - MUST be "Extension".
-   *  - name
-      - string
-      - 1..1
-      - A name for the Extension
-   *  - value
-      - ['number', 'string', 'boolean', 'object', 'array', 'null']
-      - 0..1
-      - Any primitive or structured object
+    **Information Model**
+    
+    .. list-table::
+       :class: clean-wrap
+       :header-rows: 1
+       :align: left
+       :widths: auto
+       
+       *  - Field
+          - Type
+          - Limits
+          - Description
+       *  - type
+          - string
+          - 0..1
+          - MUST be "Extension".
+       *  - name
+          - string
+          - 1..1
+          - A name for the Extension
+       *  - value
+          - ['number', 'string', 'boolean', 'object', 'array', 'null']
+          - 0..1
+          - Any primitive or structured object
diff --git a/schema/defs/core/MappableEntity.rst b/schema/defs/core/MappableEntity.rst
@@ -0,0 +1,38 @@
+**Computational Definition**
+
+an Entity that is mappable to codings in other terminology systems.
+
+    **Information Model**
+
+Some MappableEntity attributes are inherited from :ref:`Entity`.
+
+    .. list-table::
+       :class: clean-wrap
+       :header-rows: 1
+       :align: left
+       :widths: auto
+
+       *  - Field
+          - Type
+          - Limits
+          - Description
+       *  - id
+          - string
+          - 0..1
+          - The 'logical' identifier of the entity in the system of record, e.g. a UUID. This 'id' is  unique within a given system. The identified entity may have a different 'id' in a different  system, or may refer to an 'id' for the shared concept in another system (e.g. a CURIE).
+       *  - label
+          - string
+          - 0..1
+          - A primary label for the entity.
+       *  - description
+          - string
+          - 0..1
+          - A free-text description of the entity.
+       *  - extensions
+          - :ref:`Extension`
+          - 0..m
+          - 
+       *  - mappings
+          - :ref:`Mapping`
+          - 0..m
+          - 
diff --git a/schema/defs/core/Mapping.rst b/schema/defs/core/Mapping.rst
@@ -2,45 +2,49 @@
 
 A mapping to a concept in a terminology system.
 
-**Information Model**
-
+    **Information Model**
+    
 Some Mapping attributes are inherited from :ref:`Entity`.
 
-.. list-table::
-   :class: clean-wrap
-   :header-rows: 1
-   :align: left
-   :widths: auto
-
-   *  - Field
-      - Type
-      - Limits
-      - Description
-   *  - id
-      - string
-      - 0..1
-      - The 'logical' identifier of the entity in the system of record, e.g. a UUID. This 'id' is  unique within a given system. The identified entity may have a different 'id' in a different  system, or may refer to an 'id' for the shared concept in another system (e.g. a CURIE).
-   *  - label
-      - string
-      - 0..1
-      - 
-   *  - extensions
-      - :ref:`Extension`
-      - 0..m
-      - 
-   *  - system
-      - string
-      - 1..1
-      - Identity of the terminology system.
-   *  - version
-      - string
-      - 0..1
-      - Version of the terminology system.
-   *  - code
-      - :ref:`Code`
-      - 1..1
-      - Symbol in syntax defined by the terminology system.
-   *  - mapping
-      - string
-      - 1..1
-      - A mapping between concepts as defined by the Simple Knowledge Organization System (SKOS).
+    .. list-table::
+       :class: clean-wrap
+       :header-rows: 1
+       :align: left
+       :widths: auto
+
+       *  - Field
+          - Type
+          - Limits
+          - Description
+       *  - id
+          - string
+          - 0..1
+          - The 'logical' identifier of the entity in the system of record, e.g. a UUID. This 'id' is  unique within a given system. The identified entity may have a different 'id' in a different  system, or may refer to an 'id' for the shared concept in another system (e.g. a CURIE).
+       *  - label
+          - string
+          - 0..1
+          - A primary label for the entity.
+       *  - description
+          - string
+          - 0..1
+          - A free-text description of the entity.
+       *  - extensions
+          - :ref:`Extension`
+          - 0..m
+          - 
+       *  - system
+          - string
+          - 1..1
+          - Identity of the terminology system.
+       *  - version
+          - string
+          - 0..1
+          - Version of the terminology system.
+       *  - code
+          - :ref:`Code`
+          - 1..1
+          - Symbol in syntax defined by the terminology system.
+       *  - relation
+          - string
+          - 1..1
+          - A mapping relation between concepts as defined by the Simple Knowledge Organization System (SKOS).