Including empty object causes errors in doc validation #70
Conversation
| contact: options.contact ? getContact(options.contact) : {}, | ||
| license: options.license ? license(options.license) : {}, | ||
| contact: options.contact ? getContact(options.contact) : undefined, | ||
| license: options.license ? license(options.license) : undefined, |
There was a problem hiding this comment.
Thanks for the feedback. We would like to merge this PR 👍. However, is it possible to change this to instead add undefined as default value just remove the key of the final object?
...(options.contact ? { contact: getContact(options.contact) } : {}),
...(options.license ? { license: license(options.license) } : {}),
| @@ -9,7 +9,7 @@ const setServer = (server = {}) => ({ | |||
| type: 'string', | |||
| defaultValue: '', | |||
| }), | |||
| variables: server.variables ? server.variables : {}, | |||
| variables: server.variables ? server.variables : undefined, | |||
There was a problem hiding this comment.
Same thing here.
...(server.variables ? { variables: server.variables } : {}),
There was a problem hiding this comment.
If we add those changes I think we can merge this. There are some failing tests, if you want you could also fix them. If you don't want to we can have a look after we merge this, and we will be able to do an npm release.
We were also wondering what swagger validator tool are you using? so that we can have a look and prevent this kind of error in the following versions 👍 We used this one.
|
Hi, @bbrizzi could you have time to update this PR? Are you still interested in adding this to this package? 😃 |
|
We are going to cover this case in this issue #73 thanks for the feedback. We really appreciate it. |
What kind of change does this PR introduce? (check at least one)
Description:
Hey, thanks for developping this library, it's great !
I use only the processSwagger() part so I can generate and host the file separately. This makes debugging the swagger.json file easier for me.
I noticed that when I don't add contact and license to my options object, the library stills adds them with a default value of empty object which causes an error in swaggger's validator :
Structural error at info.license should have required property 'name' missingProperty: nameThe fix in this PR replaces the default {} value with undefined to fix this error. I didn't run any tests but it doesn't look like it breaks anything.
Thank you !