feat(oas3): support Schema Object title

Author: kylef

packages/openapi3-parser/CHANGELOG.md

@@ -1,5 +1,11 @@
 # API Elements: OpenAPI 3 Parser Changelog
 
+## Master
+
+### Enhancements
+
+- Adds support for the Schema Object title property.
+
 ## 0.14.0 (2020-06-24)
 
 ### Enhancements

packages/openapi3-parser/STATUS.md

@@ -196,7 +196,7 @@ support.
 | type | ✓ |
 | enum | ✓ |
 | encoding | ✕ |
-| title | ✕ |
+| title | ✓ |
 | multipleOf | ✕ |
 | maximum | ✕ |
 | exclusiveMaximum | ✕ |

packages/openapi3-parser/lib/parser/oas/parseSchemaObject.js

@@ -18,7 +18,7 @@ const parseReference = require('../parseReference');
 const name = 'Schema Object';
 const unsupportedKeys = [
   // JSON Schema
-  'title', 'multipleOf', 'maximum', 'exclusiveMaximum', 'minimum',
+  'multipleOf', 'maximum', 'exclusiveMaximum', 'minimum',
   'exclusiveMinimum', 'maxLength', 'minLength', 'pattern', 'maxItems',
   'minItems', 'uniqueItems', 'maxProperties', 'minProperties',
 
@@ -206,6 +206,7 @@ function parseSchema(context) {
     [hasKey('items'), R.compose(parseSubSchema, getValue)],
     [hasKey('required'), R.compose(parseRequired, getValue)],
     [hasKey('nullable'), parseBoolean(context, name, false)],
+    [hasKey('title'), parseString(context, name, false)],
     [hasKey('description'), parseString(context, name, false)],
     [hasKey('default'), e => e.clone()],
     [hasKey('example'), e => e.clone()],
@@ -253,6 +254,11 @@ function parseSchema(context) {
         ];
       }
 
+      const title = schema.getValue('title');
+      if (title) {
+        element.title = title;
+      }
+
       const description = schema.getValue('description');
       if (description) {
         element.description = description;

packages/openapi3-parser/test/unit/parser/oas/parseSchemaObject-test.js

@@ -552,6 +552,34 @@ describe('Schema Object', () => {
     });
   });
 
+  describe('#title', () => {
+    it('warns when title is not a string', () => {
+      const schema = new namespace.elements.Object({
+        title: true,
+      });
+      const parseResult = parse(context, schema);
+
+      expect(parseResult.length).to.equal(2);
+
+      expect(parseResult).to.contain.warning(
+        "'Schema Object' 'title' is not a string"
+      );
+    });
+
+    it('adds a title to the returned element', () => {
+      const schema = new namespace.elements.Object({
+        title: 'User',
+      });
+      const parseResult = parse(context, schema);
+
+      expect(parseResult.length).to.equal(1);
+      expect(parseResult.get(0)).to.be.instanceof(namespace.elements.DataStructure);
+
+      const element = parseResult.get(0).content;
+      expect(element.title.toValue()).to.equal('User');
+    });
+  });
+
   describe('#description', () => {
     it('warns when description is not a string', () => {
       const schema = new namespace.elements.Object({