feat(oas3): support parameter object enums

Author: kylef

packages/openapi3-parser/CHANGELOG.md

@@ -1,5 +1,12 @@
 # API Elements: OpenAPI 3 Parser Changelog
 
+## TBD
+
+### Enhancements
+
+- Support for the 'enum' property in 'Schema Object's found within 'Parameter
+  Object'.
+
 ## 0.15.2 (2021-02-15)
 
 ### Enhancements

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

@@ -10,6 +10,7 @@ const {
 const pipeParseResult = require('../../pipeParseResult');
 const parseObject = require('../parseObject');
 const parseString = require('../parseString');
+const parseEnum = require('../parseEnum');
 
 const name = 'Schema Object';
 const unsupportedKeys = [
@@ -88,6 +89,7 @@ function parseSchemaObject(context) {
   const parseMember = R.cond([
     [hasKey('type'), parseType],
     [hasKey('example'), e => e.clone()],
+    [hasKey('enum'), R.compose(parseEnum(context, name), getValue)],
 
     [isUnsupportedKey, createUnsupportedMemberWarning(namespace, name)],
     [isExtension, () => new namespace.elements.ParseResult()],
@@ -101,7 +103,11 @@ function parseSchemaObject(context) {
       const type = schema.getValue('type');
       let element;
 
-      if (type === 'object') {
+      const enumerations = schema.get('enum');
+
+      if (enumerations) {
+        element = enumerations;
+      } else if (type === 'object') {
         element = new namespace.elements.Object();
       } else if (type === 'array') {
         element = new namespace.elements.Array();

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

@@ -630,6 +630,24 @@ describe('Parameter Object', () => {
       expect(member.value.attributes.get('samples').toValue()).to.deep.equal([2048]);
     });
 
+    it('uses enum', () => {
+      const parameter = new namespace.elements.Object({
+        name: 'example',
+        in: 'query',
+        schema: {
+          enum: ['0', '1'],
+        },
+      });
+
+      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.Enum);
+      expect(member.value.enumerations.toValue()).to.deep.equal(['0', '1']);
+    });
+
     it('provides a warning when schema is not an object', () => {
       const parameter = new namespace.elements.Object({
         name: 'example',