feat(schema): add support for keyword $defs

adobe · Dec 16, 2019 · 70b63c8 · 70b63c8
1 parent 0982f31
commit 70b63c8
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 25 deletions.
diff --git a/lib/markdownBuilder.js b/lib/markdownBuilder.js
@@ -765,29 +765,32 @@ function build({
    * @param {*} schema
    */
   function makedefinitions(schema, slugger) {
-    if (schema.definitions) {
-      const defgroups = Object.entries(schema.definitions).map(([groupname, subschema]) => {
-        const grouptable = makeproptable(
-          subschema[keyword`properties`],
-          subschema[keyword`patternProperties`],
-          subschema[keyword`additionalProperties`],
-          subschema[keyword`required`],
-          slugger,
-        );
-        return [
-          heading(2, text(i18n`Definitions group ${groupname}`)),
-          paragraph(text(i18n`Reference this group by using`)),
-          code('json', JSON.stringify({ $ref: `${subschema[s.id]}#${subschema[s.pointer]}` })),
-          grouptable,
-          ...makeproplist(
+    if (schema.definitions || schema[keyword`$defs`]) {
+      const defgroups = [
+        ...Object.entries(schema[keyword`$defs`] || {}),
+        ...Object.entries(schema.definitions || {})]
+        .map(([groupname, subschema]) => {
+          const grouptable = makeproptable(
             subschema[keyword`properties`],
             subschema[keyword`patternProperties`],
             subschema[keyword`additionalProperties`],
             subschema[keyword`required`],
-            2,
-          ),
-        ];
-      });
+            slugger,
+          );
+          return [
+            heading(2, text(i18n`Definitions group ${groupname}`)),
+            paragraph(text(i18n`Reference this group by using`)),
+            code('json', JSON.stringify({ $ref: `${subschema[s.id]}#${subschema[s.pointer]}` })),
+            grouptable,
+            ...makeproplist(
+              subschema[keyword`properties`],
+              subschema[keyword`patternProperties`],
+              subschema[keyword`additionalProperties`],
+              subschema[keyword`required`],
+              2,
+            ),
+          ];
+        });
 
       return [
         heading(1, text(i18n`${gentitle(schema[s.titles], schema[keyword`type`])} Definitions`)),

diff --git a/schemasupport.md b/schemasupport.md
@@ -1,16 +1,16 @@
 # JSON Schema Spec Coverage Report
 
-This report lists the keywords of the JSON Schema spec that are covered in the tests. The overall coverage is 81%
+This report lists the keywords of the JSON Schema spec that are covered in the tests. The overall coverage is 82%
 
 ## The JSON Schema Core Vocabulary
 
-Coverage for [The JSON Schema Core Vocabulary](https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.8.1) is 33%.
+Coverage for [The JSON Schema Core Vocabulary](https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.8.1) is 44%.
 
 | Keyword            | Supported |
 | :----------------- | --------- |
 | `$anchor`          | No        |
 | `$comment`         | Yes       |
-| `$defs`            | No        |
+| `$defs`            | Yes       |
 | `$id`              | Yes       |
 | `$recursiveAnchor` | No        |
 | `$recursiveRef`    | No        |

diff --git a/test/fixtures/readme-1/abstract.schema.json b/test/fixtures/readme-1/abstract.schema.json
@@ -12,7 +12,7 @@
   "writeOnly": true,
   "description": "This is an abstract schema. It has `definitions`, but does not declare any properties",
   "type": "object",
-  "definitions": {
+  "$defs": {
     "first": {
       "type": "object",
       "properties": {

diff --git a/test/markdownBuilder.test.js b/test/markdownBuilder.test.js
@@ -258,15 +258,15 @@ describe('Testing Markdown Builder: readme-1', () => {
 Reference this group by using
 
 \`\`\`json
-{"$ref":"https://example.com/schemas/abstract#/definitions/second"}
+{"$ref":"https://example.com/schemas/abstract#/$defs/second"}
 \`\`\``
       .fuzzy`
 \`bar\`
 
 -   is optional
 -   Type: \`string\`
 -   cannot be null
--   defined in: [Abstract](abstract-definitions-second-properties-bar.md "https&#x3A;//example.com/schemas/abstract#/definitions/second/properties/bar")
+-   defined in: [Abstract](abstract-defs-second-properties-bar.md "https&#x3A;//example.com/schemas/abstract#/$defs/second/properties/bar")
 
 #### bar Type