Skip to content

Commit a346a6b

Browse files
authored
Merge pull request #1964 from braingram/metaschemas_note
add note discouraging metaschemas
2 parents cf52ec0 + ab0a791 commit a346a6b

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

changes/1964.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update metaschemas description discouraging custom metaschemas.

docs/asdf/extending/schemas.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ indicates that we're following version 1.1 of the YAML spec. The
7070
7171
The ``$schema`` property contains the URI of the schema that validates
7272
this document. Since our document is itself a schema, the URI refers to
73-
a *metaschema*. ASDF comes with three built-in metaschemas:
73+
a *metaschema*. ASDF comes with two built-in metaschemas:
7474

7575
- ``http://json-schema.org/draft-04/schema`` - The JSON Schema Draft 4 metaschema.
7676
Includes basic validators and combiners.
@@ -79,9 +79,8 @@ a *metaschema*. ASDF comes with three built-in metaschemas:
7979
Includes everything in JSON Schema Draft 4, plus additional YAML-specific
8080
validators including ``tag`` and ``propertyOrder``.
8181

82-
- ``http://stsci.edu/schemas/asdf/asdf-schema-1.0.0`` - The ASDF Schema metaschema.
83-
Includes everything in YAML Schema, plus additional ASDF-specific validators
84-
that check ndarray properties.
82+
Using any other metaschema is not recommended as these are generally poorly
83+
supported by jsonschema validators.
8584

8685
Our schema makes use of the ``tag`` validator, so we're specifying the YAML Schema
8786
URI here.

0 commit comments

Comments
 (0)