fix: include Title in referenced definitions (#541)

* Include Title in referenced definitions * Tests update --------- Co-authored-by: Sean Jonker <[email protected]>
YousefED · May 15, 2023 · d2124fd · d2124fd
1 parent d9484e8
commit d2124fd
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 3 deletions.
diff --git a/test/programs/annotation-title/main.ts b/test/programs/annotation-title/main.ts
@@ -5,11 +5,18 @@ interface MySubObject {
     a: boolean;
 }
 
+interface AnotherSubObject {
+    b: boolean;
+}
+
 interface MyObject {
     /**
      * @title empty#
      */
     empty;
-
+    /**
+     * @title filled
+     */
     filled: MySubObject;
+    nonTitled: AnotherSubObject;
 }
diff --git a/test/programs/annotation-title/schema.json b/test/programs/annotation-title/schema.json
@@ -1,6 +1,15 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "definitions": {
+    "AnotherSubObject": {
+      "properties": {
+        "b": {
+          "type": "boolean"
+        }
+      },
+      "required": ["b"],
+      "type": "object"
+    },
     "MySubObject": {
       "title": "filled#",
       "type": "object",
@@ -15,9 +24,13 @@
       "title": "empty#"
     },
     "filled": {
-      "$ref": "#/definitions/MySubObject"
+      "$ref": "#/definitions/MySubObject",
+      "title": "filled"
+    },
+    "nonTitled": {
+      "$ref": "#/definitions/AnotherSubObject"
     }
   },
-  "required": ["empty", "filled"],
+  "required": ["empty", "filled", "nonTitled"],
   "type": "object"
 }
diff --git a/typescript-json-schema.ts b/typescript-json-schema.ts
@@ -438,6 +438,7 @@ const annotationKeywords: { [k in keyof typeof validationKeywords]?: true } = {
     description: true,
     default: true,
     examples: true,
+    title: true,
     // A JSDoc $ref annotation can appear as a $ref.
     $ref: true,
 };