sync metaschema

Author: mr-c

.github/workflows/spellcheck.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Codespell with annotations
         uses: codespell-project/[email protected]
         with:
-          skip: tests/EDAM.owl,tests/foaf.rdf,tests/underscore.js
+          skip: EDAM.owl,foaf.rdf,underscore.js,CODE_OF_CONDUCT.md
       - uses: rojopolis/[email protected]
         name: Spellcheck
         # https://github.com/marketplace/actions/github-spellcheck-action

salad/schema_salad/metaschema/field_name_schema.yml

@@ -5,6 +5,7 @@
   "$graph": [{
     "name": "ExampleType",
     "type": "record",
+    "documentRoot": true,
     "fields": [{
       "name": "base",
       "type": "string",

salad/schema_salad/metaschema/ident_res_schema.yml

@@ -5,6 +5,7 @@
   "$graph": [{
     "name": "ExampleType",
     "type": "record",
+    "documentRoot": true,
     "fields": [{
       "name": "id",
       "type": "string",

salad/schema_salad/metaschema/import_include.md

@@ -16,8 +16,9 @@ document must be the URI used to retrieve the imported document.  If the
 `$import` URI includes a document fragment, the fragment must be excluded
 from the base URI used to preprocess the imported document.
 
-Once loaded and processed, the `$import` node is replaced in the document
-structure by the object or array yielded from the import operation.
+If the `$import` node is in an array and the import operation yields an array,
+it is flattened to the parent array. Otherwise the `$import` node is replaced
+in the document structure by the object or array yielded from the import operation.
 
 URIs may reference document fragments which refer to specific an object in
 the target document.  This indicates that the `$import` node must be
@@ -26,7 +27,7 @@ replaced by only the object with the appropriate fragment identifier.
 It is a fatal error if an import directive refers to an external resource
 or resource fragment which does not exist or is not accessible.
 
-### Import example
+### Import example: replacing the `$import` node
 
 import.json:
 ```
@@ -60,6 +61,38 @@ This becomes:
 }
 ```
 
+### Import example: flattening the `$import`ed array
+
+import.json:
+```
+[ "hello", "world" ]
+```
+
+parent.json:
+```
+{
+  "form": [
+    "bar",
+    {
+      "$import": "import.json"
+    }
+  ]
+}
+
+```
+
+This becomes:
+
+```
+{
+  "form": [
+    "bar",
+    "hello",
+    "world"
+  ]
+}
+```
+
 ## Include
 
 During preprocessing traversal, an implementation must resolve `$include`

salad/schema_salad/metaschema/link_res.yml

@@ -2,7 +2,7 @@
   ## Link resolution
 
   The schema may designate one or more fields as link fields that reference other
-  objects.  Processing must resolve links to either absolute URIs using the
+  objects.  Processing must resolve links to absolute URIs using the
   following rules:
 
   * If a reference URI is prefixed with `#` it is a relative

salad/schema_salad/metaschema/metaschema.yml

@@ -154,7 +154,7 @@ $graph:
         then finally `#foo`.  The first valid URI in the search order shall be
         used as the fully resolved value of the identifier.  The value of the
         refScope field is the specified number of levels from the containing
-        identifer scope before starting the search, so if `refScope: 2` then
+        identifier scope before starting the search, so if `refScope: 2` then
         "baz" and "bar" must be stripped to get the base `#foo` and search
         `#foo/foo` and the `#foo`.  The last scope searched must be the top
         level scope before determining if the identifier cannot be resolved.
@@ -309,7 +309,8 @@ $graph:
       type: boolean?
       doc: |
         If true, this record is abstract and may be used as a base for other
-        records, but is not valid on its own.
+        records, but is not valid on its own. Inherited fields may be
+        re-specified to narrow their type.
 
     - name: extends
       type:
@@ -321,7 +322,7 @@ $graph:
         refScope: 1
       doc: |
         Indicates that this record inherits fields from one or more base records.
-
+        Inherited fields may be re-specified to narrow their type.
     - name: specialize
       type:
         - SpecializeDef[]?
@@ -368,6 +369,7 @@ $graph:
       doc: "Must be `documentation`"
       type:
         type: enum
+        name: Documentation_name
         symbols:
           - "sld:documentation"
       jsonldPredicate:

salad/schema_salad/metaschema/metaschema_base.yml

@@ -39,8 +39,9 @@ $graph:
     - "xsd:string"
   doc:
     - |
-      Salad data types are based on Avro schema declarations.  Refer to the
-      [Avro schema declaration documentation](https://avro.apache.org/docs/current/spec.html#schemas) for
+      Names of salad data types (based on Avro schema declarations).
+
+      Refer to the [Avro schema declaration documentation](https://avro.apache.org/docs/current/spec.html#schemas) for
       detailed information.
     - "null: no value"
     - "boolean: a binary value"
@@ -100,6 +101,7 @@ $graph:
       doc: "Must be `record`"
       type:
         type: enum
+        name: Record_name
         symbols:
           - "sld:record"
       jsonldPredicate:
@@ -125,13 +127,17 @@ $graph:
       doc: "Must be `enum`"
       type:
         type: enum
+        name: Enum_name
         symbols:
           - "sld:enum"
       jsonldPredicate:
         _id: "sld:type"
         _type: "@vocab"
         typeDSL: true
         refScope: 2
+    name:
+      type: string?
+      jsonldPredicate: "@id"
     symbols:
       type: string[]
       jsonldPredicate:
@@ -148,6 +154,7 @@ $graph:
       doc: "Must be `array`"
       type:
         type: enum
+        name: Array_name
         symbols:
           - "sld:array"
       jsonldPredicate:
@@ -173,5 +180,4 @@ $graph:
         _id: "sld:items"
         _type: "@vocab"
         refScope: 2
-        typeDSL: True
       doc: "Defines the type of the array elements."

salad/schema_salad/metaschema/salad.md

@@ -2,13 +2,14 @@
 
 Author:
 
-* Peter Amstutz <[email protected]>, Arvados Project, Curii Corporation
+* Peter Amstutz <[email protected]>, Curii Corporation
 
 Contributors:
 
 * The developers of Apache Avro
 * The developers of JSON-LD
 * Nebojša Tijanić <[email protected]>, Seven Bridges Genomics
+* Michael R. Crusoe, ELIXIR-DE
 
 # Abstract
 
@@ -72,7 +73,7 @@ documentation.
 
 ## Introduction to v1.1
 
-This is the third version of the Schema Salad specification.  It is
+This is the third version of of the Schema Salad specification.  It is
 developed concurrently with v1.1 of the Common Workflow Language for use in
 specifying the Common Workflow Language, however Schema Salad is intended to be
 useful to a broader audience.  Compared to the v1.0 schema salad
@@ -86,6 +87,13 @@ specification, the following changes have been made:
   is poorly documented, not included in conformance testing,
   and not widely supported.
 
+## Introduction to v1.2
+
+This is the fourth version of the Schema Salad specification. It was created to
+ease the development of extensions to CWL v1.2. The only change is that
+inherited records can narrow the types of fields if those fields are re-specified
+with a matching jsonldPredicate.
+
 ## References to Other Specifications
 
 **Javascript Object Notation (JSON)**: http://json.org
@@ -113,7 +121,7 @@ the behavior of conforming implementations.
 
 The terminology used to describe Salad documents is defined in the Concepts
 section of the specification. The terms defined in the following list are
-used in building those definitions and in describing the actions of a
+used in building those definitions and in describing the actions of an
 Salad implementation:
 
 **may**: Conforming Salad documents and Salad implementations are permitted but
@@ -139,7 +147,7 @@ enable or disable the behavior described.
 ## Data concepts
 
 An **object** is a data structure equivalent to the "object" type in JSON,
-consisting of an unordered set of name/value pairs (referred to here as
+consisting of a unordered set of name/value pairs (referred to here as
 **fields**) and where the name is a string and the value is a string, number,
 boolean, array, or object.
 
@@ -248,23 +256,26 @@ rules:
   field.
 
   * If the value of `jsonldPredicate` is an object, and that
-  object contains the field `_type` with the value `@id`, the field is a
-  link field subject to [link validation](#Link_validation).
+  object contains the field `_type` with the value `@id`, the
+  field is a link field.  If the field `jsonldPredicate` also
+  has the field `identity` with the value `true`, the field is
+  resolved with [identifier resolution](#Identifier_resolution).
+  Otherwise it is resolved with [link resolution](#Link_resolution).
 
   * If the value of `jsonldPredicate` is an object which contains the
   field `_type` with the value `@vocab`, the field value is subject to
   [vocabulary resolution](#Vocabulary_resolution).
 
 ## Document traversal
 
-To perform document preprocessing, link validation and schema
+To perform document document preprocessing, link validation and schema
 validation, the document must be traversed starting from the fields or
 array items of the root object or array and recursively visiting each child
 item which contains an object or arrays.
 
 ## Short names
 
-The "short name" of a fully qualified identifier is the portion of
+The "short name" of an fully qualified identifier is the portion of
 the identifier following the final slash `/` of either the fragment
 identifier following `#` or the path portion, if there is no fragment.
 Some examples:

salad/schema_salad/metaschema/typedsl_res.yml

@@ -5,7 +5,7 @@
   following micro-DSL for schema salad types:
 
   * If the type ends with a question mark `?`, the question mark is stripped off and the type is expanded to a union with `null`
-  * If the type ends with square brackets `[]` it is expanded to an array with items of the preceeding type symbol
+  * If the type ends with square brackets `[]` it is expanded to an array with items of the preceding type symbol
   * The type may end with both `[]?` to indicate it is an optional array.
   * Identifier resolution is applied after type DSL expansion.