feat(oas3): support parameter object title/description

Author: kylef

packages/openapi3-parser/CHANGELOG.md

@@ -4,8 +4,8 @@
 
 ### Enhancements
 
-- Support for the 'enum' property in 'Schema Object's found within 'Parameter
-  Object'.
+- Support for the 'title', 'description', and 'enum' properties in 'Schema
+  Object's found within 'Parameter Object'.
 
 ## 0.15.2 (2021-02-15)
 

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

@@ -16,8 +16,8 @@ const name = 'Schema Object';
 const unsupportedKeys = [
   '$ref', 'multipleOf', 'maximum', 'exclusiveMaximum', 'minimum',
   'exclusiveMinimum', 'maxLength', 'minLength', 'pattern', 'maxItems',
-  'minItems', 'uniqueItems', 'maxProperties', 'minProperties', 'enum',
-  'properties', 'items', 'required', 'nullable', 'title', 'description',
+  'minItems', 'uniqueItems', 'maxProperties', 'minProperties',
+  'properties', 'items', 'required', 'nullable',
   'default', 'oneOf', 'allOf', 'anyOf', 'not', 'additionalProperties',
   'format', 'discriminator', 'readOnly', 'writeOnly', 'xml', 'externalDocs',
   'deprecated',
@@ -91,6 +91,9 @@ function parseSchemaObject(context) {
     [hasKey('example'), e => e.clone()],
     [hasKey('enum'), R.compose(parseEnum(context, name), getValue)],
 
+    [hasKey('title'), parseString(context, name, false)],
+    [hasKey('description'), parseString(context, name, false)],
+
     [isUnsupportedKey, createUnsupportedMemberWarning(namespace, name)],
     [isExtension, () => new namespace.elements.ParseResult()],
     [R.T, createInvalidMemberWarning(namespace, name)],
@@ -121,6 +124,16 @@ function parseSchemaObject(context) {
         return new namespace.elements.ParseResult([]);
       }
 
+      const title = schema.getValue('title');
+      if (title) {
+        element.title = title;
+      }
+
+      const description = schema.getValue('description');
+      if (description) {
+        element.description = description;
+      }
+
       const example = schema.get('example');
       if (example) {
         element.attributes.set('samples', [example]);

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

@@ -648,6 +648,44 @@ describe('Parameter Object', () => {
       expect(member.value.enumerations.toValue()).to.deep.equal(['0', '1']);
     });
 
+    it('attaches title', () => {
+      const parameter = new namespace.elements.Object({
+        name: 'example',
+        in: 'query',
+        schema: {
+          type: 'string',
+          title: 'Example Title',
+        },
+      });
+
+      const parseResult = parse(context, parameter);
+
+      expect(parseResult.length).to.equal(1);
+      const member = parseResult.get(0);
+      expect(member).to.be.instanceof(namespace.elements.Member);
+      expect(member.value).to.be.instanceof(namespace.elements.String);
+      expect(member.value.title.toValue()).to.equal('Example Title');
+    });
+
+    it('attaches description', () => {
+      const parameter = new namespace.elements.Object({
+        name: 'example',
+        in: 'query',
+        schema: {
+          type: 'string',
+          description: 'Example Description',
+        },
+      });
+
+      const parseResult = parse(context, parameter);
+
+      expect(parseResult.length).to.equal(1);
+      const member = parseResult.get(0);
+      expect(member).to.be.instanceof(namespace.elements.Member);
+      expect(member.value).to.be.instanceof(namespace.elements.String);
+      expect(member.value.description.toValue()).to.equal('Example Description');
+    });
+
     it('provides a warning when schema is not an object', () => {
       const parameter = new namespace.elements.Object({
         name: 'example',