feat: add warning for binary string in "application/json" or parameter

[barrett-schonefeld]

Changes:

• added a findOctetSequencePaths function to handle the logic of finding schema type: string, format: binary for cases of nested arrays, objects, nested arrays of type object, objects with properties that are nested arrays, and objects with properties that are objects, and the simple case where a schema uses type: string, format: binary directly. This function takes a resolved schema and returns a list of paths to octet sequences (empty list if none found). The function accepts the path both as an array and a string and returns the path in the same format received.
• added logic to handle application/json request bodies that use schema type: string, format: binary
• added logic to handle application/json response bodies of type: string, format: binary
• added logic to handle parameters of type: string, format: binary
• removed 'binary' as a valid format for type: string parameters. parameters of type: string, format: binary will result in "type+format not well-defined" error
• added "json_or_param_binary_string" as to .defaultsForValidator as a warning in the shared.schemas section
• added "json_or_param_binary_string" configuration option to the README.md rules and defaults sections in the schemas section
• changed findOctetSequencePaths to accept the path both as a string and an array.

Refactoring in responses.js:

• moved the check for 204-response with content to be part of the other success code checks
• added a function to get all response codes, all status codes, and all success codes

Tests:

• added tests to ensure warnings are issued for request bodies, response bodies, and parameters with schema, type: string, format: binary
• added complex tests to exercise combinations of nested arrays and objects that contain schema type: string, format: binary (complex tests done on response bodies)

[codecov]

Codecov Report

Merging #139 into master will increase coverage by 0.22%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #139      +/-   ##
==========================================
+ Coverage   92.99%   93.22%   +0.22%     
==========================================
  Files          59       60       +1     
  Lines        2156     2229      +73     
==========================================
+ Hits         2005     2078      +73     
  Misses        151      151

Impacted Files	Coverage Δ
...dation/2and3/semantic-validators/parameters-ibm.js	93.02% <ø> (ø)	⬆️
src/.defaultsForValidator.js	100% <ø> (ø)	⬆️
.../validation/oas3/semantic-validators/parameters.js	100% <100%> (ø)	⬆️
.../validation/oas3/semantic-validators/operations.js	97.91% <100%> (+0.61%)	⬆️
...s/validation/oas3/semantic-validators/responses.js	100% <100%> (ø)	⬆️
src/plugins/utils/findOctetSequencePaths.js	100% <100%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ab2bc90...81eacff. Read the comment docs.

[mkistler]

This is heading in the right direction but I left some comments with suggested improvements or questions.

[dpopp07]

There are a few minor changes to make and then potentially larger changes in how we handle the configuration situation. I also would like to see one positive test that proves the correct usage of a binary property will not create a warning.

[dpopp07]

Looking pretty good. Probably the last thing to do is discuss the config stuff. I'll think about it and get back to you

[dpopp07]

One little thing to address, but looks good otherwise! I'm approving but I'll wait to merge in case @mkistler wants to take one more look at it

[dpopp07]

Looks good! I'll see if @mkistler wants to take one more look and then merge this morning

Requested changes have been addressed

[dpopp07]

🎉 This PR is included in version 0.21.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀