fix(oas2): add optional typeAttribute for optional parameters

kylef · kylef · commit 0288e878982b · 2019-08-06T12:58:58.000+01:00
diff --git a/packages/fury-adapter-swagger/CHANGELOG.md b/packages/fury-adapter-swagger/CHANGELOG.md
@@ -7,6 +7,10 @@
 - Prevents a 'Path Item Object' from being included in a Resource Group created
   by an 'Operation Object' in a previously defined 'Path Item Object'.
 
+- Optional parameters will now include an optional typeAttribute in the parse
+  result. This will fix conversion to API Blueprint with fury-cli where
+  optional parameters have shown up as required in the generated API Blueprint.
+
 ## 0.27.1 (2019-06-03)
 
 ### Bug Fixes
diff --git a/packages/fury-adapter-swagger/lib/parser.js b/packages/fury-adapter-swagger/lib/parser.js
@@ -1445,6 +1445,8 @@ class Parser {
 
     if (parameter.required) {
       member.attributes.set('typeAttributes', ['required']);
+    } else {
+      member.attributes.set('typeAttributes', ['optional']);
     }
 
     return member;
diff --git a/packages/fury-adapter-swagger/test/fixtures/parameter-array-default-warning.json b/packages/fury-adapter-swagger/test/fixtures/parameter-array-default-warning.json
@@ -52,6 +52,17 @@
                           "content": "Query argument"
                         }
                       },
+                      "attributes": {
+                        "typeAttributes": {
+                          "element": "array",
+                          "content": [
+                            {
+                              "element": "string",
+                              "content": "optional"
+                            }
+                          ]
+                        }
+                      },
                       "content": {
                         "key": {
                           "element": "string",
diff --git a/packages/fury-adapter-swagger/test/parameter-test.js b/packages/fury-adapter-swagger/test/parameter-test.js
@@ -3,7 +3,7 @@ const { Fury } = require('fury');
 const Parser = require('../lib/parser');
 
 const { minim: namespace } = new Fury();
-const { Annotation } = namespace.elements;
+const { Annotation, Member } = namespace.elements;
 
 describe('Parameter to Member converter', () => {
   it('can convert a parameter to a member with x-example', () => {
@@ -228,4 +228,34 @@ describe('Parameter to Member converter', () => {
     expect(parser.result.get(0)).to.be.instanceof(Annotation);
     expect(parameter.toValue()).to.equal('true');
   });
+
+  describe('#typeAttributes', () => {
+    it('adds required typeAttribute for required as truthy', () => {
+      const parser = new Parser({ namespace, source: '' });
+      parser.result = new namespace.elements.ParseResult();
+      const parameter = parser.convertParameterToMember({
+        type: 'string',
+        required: true,
+      });
+
+      expect(parameter).to.be.instanceof(Member);
+
+      const typeAttributes = parameter.attributes.getValue('typeAttributes');
+      expect(typeAttributes).to.deep.equal(['required']);
+    });
+
+    it('adds required typeAttribute for required as truthy', () => {
+      const parser = new Parser({ namespace, source: '' });
+      parser.result = new namespace.elements.ParseResult();
+      const parameter = parser.convertParameterToMember({
+        type: 'string',
+        required: false,
+      });
+
+      expect(parameter).to.be.instanceof(Member);
+
+      const typeAttributes = parameter.attributes.getValue('typeAttributes');
+      expect(typeAttributes).to.deep.equal(['optional']);
+    });
+  });
 });
diff --git a/packages/swagger-zoo/fixtures/features/api-elements/param-with-enum-default.json b/packages/swagger-zoo/fixtures/features/api-elements/param-with-enum-default.json
@@ -52,6 +52,17 @@
                           "content": "Query argument"
                         }
                       },
+                      "attributes": {
+                        "typeAttributes": {
+                          "element": "array",
+                          "content": [
+                            {
+                              "element": "string",
+                              "content": "optional"
+                            }
+                          ]
+                        }
+                      },
                       "content": {
                         "key": {
                           "element": "string",
@@ -125,6 +136,17 @@
                           "content": "Query argument 2"
                         }
                       },
+                      "attributes": {
+                        "typeAttributes": {
+                          "element": "array",
+                          "content": [
+                            {
+                              "element": "string",
+                              "content": "optional"
+                            }
+                          ]
+                        }
+                      },
                       "content": {
                         "key": {
                           "element": "string",
diff --git a/packages/swagger-zoo/fixtures/features/api-elements/param-with-enum-default.sourcemap.json b/packages/swagger-zoo/fixtures/features/api-elements/param-with-enum-default.sourcemap.json
@@ -175,6 +175,15 @@
                               ]
                             }
                           ]
+                        },
+                        "typeAttributes": {
+                          "element": "array",
+                          "content": [
+                            {
+                              "element": "string",
+                              "content": "optional"
+                            }
+                          ]
                         }
                       },
                       "content": {
@@ -390,6 +399,15 @@
                               ]
                             }
                           ]
+                        },
+                        "typeAttributes": {
+                          "element": "array",
+                          "content": [
+                            {
+                              "element": "string",
+                              "content": "optional"
+                            }
+                          ]
                         }
                       },
                       "content": {
diff --git a/packages/swagger-zoo/fixtures/features/api-elements/recursion.json b/packages/swagger-zoo/fixtures/features/api-elements/recursion.json
@@ -113,6 +113,17 @@
                               "content": "Test 1 2"
                             }
                           },
+                          "attributes": {
+                            "typeAttributes": {
+                              "element": "array",
+                              "content": [
+                                {
+                                  "element": "string",
+                                  "content": "optional"
+                                }
+                              ]
+                            }
+                          },
                           "content": {
                             "key": {
                               "element": "string",
diff --git a/packages/swagger-zoo/fixtures/features/api-elements/recursion.sourcemap.json b/packages/swagger-zoo/fixtures/features/api-elements/recursion.sourcemap.json
@@ -311,6 +311,15 @@
                                   ]
                                 }
                               ]
+                            },
+                            "typeAttributes": {
+                              "element": "array",
+                              "content": [
+                                {
+                                  "element": "string",
+                                  "content": "optional"
+                                }
+                              ]
                             }
                           },
                           "content": {
diff --git a/packages/swagger-zoo/fixtures/features/api-elements/x-example.json b/packages/swagger-zoo/fixtures/features/api-elements/x-example.json
@@ -57,6 +57,17 @@
                 },
                 {
                   "element": "member",
+                  "attributes": {
+                    "typeAttributes": {
+                      "element": "array",
+                      "content": [
+                        {
+                          "element": "string",
+                          "content": "optional"
+                        }
+                      ]
+                    }
+                  },
                   "content": {
                     "key": {
                       "element": "string",
diff --git a/packages/swagger-zoo/fixtures/features/api-elements/x-example.sourcemap.json b/packages/swagger-zoo/fixtures/features/api-elements/x-example.sourcemap.json
@@ -178,6 +178,15 @@
                           ]
                         }
                       ]
+                    },
+                    "typeAttributes": {
+                      "element": "array",
+                      "content": [
+                        {
+                          "element": "string",
+                          "content": "optional"
+                        }
+                      ]
                     }
                   },
                   "content": {

Original file line number	Diff line number	Diff line change
`@@ -1445,6 +1445,8 @@ class Parser {`
`1445`	`1445`
`1446`	`1446`	`if (parameter.required) {`
`1447`	`1447`	`member.attributes.set('typeAttributes', ['required']);`
	`1448`	`+ } else {`
	`1449`	`+ member.attributes.set('typeAttributes', ['optional']);`
`1448`	`1450`	`}`
`1449`	`1451`
`1450`	`1452`	`return member;`
Original file line number	Diff line number	Diff line change
`@@ -175,6 +175,15 @@`
`175`	`175`	`]`
`176`	`176`	`}`
`177`	`177`	`]`
	`178`	`+ },`
	`179`	`+ "typeAttributes": {`
	`180`	`+ "element": "array",`
	`181`	`+ "content": [`
	`182`	`+ {`
	`183`	`+ "element": "string",`
	`184`	`+ "content": "optional"`
	`185`	`+ }`
	`186`	`+ ]`
`178`	`187`	`}`
`179`	`188`	`},`
`180`	`189`	`"content": {`
`@@ -390,6 +399,15 @@`
`390`	`399`	`]`
`391`	`400`	`}`
`392`	`401`	`]`
	`402`	`+ },`
	`403`	`+ "typeAttributes": {`
	`404`	`+ "element": "array",`
	`405`	`+ "content": [`
	`406`	`+ {`
	`407`	`+ "element": "string",`
	`408`	`+ "content": "optional"`
	`409`	`+ }`
	`410`	`+ ]`
`393`	`411`	`}`
`394`	`412`	`},`
`395`	`413`	`"content": {`
Original file line number	Diff line number	Diff line change
`@@ -311,6 +311,15 @@`
`311`	`311`	`]`
`312`	`312`	`}`
`313`	`313`	`]`
	`314`	`+ },`
	`315`	`+ "typeAttributes": {`
	`316`	`+ "element": "array",`
	`317`	`+ "content": [`
	`318`	`+ {`
	`319`	`+ "element": "string",`
	`320`	`+ "content": "optional"`
	`321`	`+ }`
	`322`	`+ ]`
`314`	`323`	`}`
`315`	`324`	`},`
`316`	`325`	`"content": {`
Original file line number	Diff line number	Diff line change
`@@ -178,6 +178,15 @@`
`178`	`178`	`]`
`179`	`179`	`}`
`180`	`180`	`]`
	`181`	`+ },`
	`182`	`+ "typeAttributes": {`
	`183`	`+ "element": "array",`
	`184`	`+ "content": [`
	`185`	`+ {`
	`186`	`+ "element": "string",`
	`187`	`+ "content": "optional"`
	`188`	`+ }`
	`189`	`+ ]`
`181`	`190`	`}`
`182`	`191`	`},`
`183`	`192`	`"content": {`