fix: validating cookie parameter for req-validator #225
Conversation
At the moment, we do not support cookie parameters in request-validator plugin. However, `deck file openapi2kong` command generates the yaml file even if it is present in the parameter schema. Thus, adding a validation layer over it to ensure deck does not create invalid specs. For: #223
Prashansa-K
force-pushed
the
fix/validate-for-cookie-presence
branch
from
2fef98b
to
854f110
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #225 +/- ##
==========================================
+ Coverage 68.97% 69.06% +0.08%
==========================================
Files 24 24
Lines 3343 3352 +9
==========================================
+ Hits 2306 2315 +9
Misses 864 864
Partials 173 173 ☔ View full report in Codecov by Sentry. |
openapi2kong/validator.go
Outdated
| return nil, fmt.Errorf(`cookie parameters are not supported for request-validator plugin; | ||
| choose either path, query or header`) |
There was a problem hiding this comment.
I don't think it should throw an error, but should log a warning, and continue without generating the validation logic.
Similar to bodies, where the content type isn't json.
There was a problem hiding this comment.
and most likely we should make it more explicit in the docs, that Cookie isn't supported
At the moment, we do not support cookie parameters in request-validator plugin. However, `deck file openapi2kong` command generates the yaml file even if it is present in the parameter schema. Thus, adding a validation layer over it to ensure deck does not create invalid specs. For: #223
Prashansa-K
force-pushed
the
fix/validate-for-cookie-presence
branch
from
cf85ec6
to
b67debf
Compare
| logbasics.Info(`cookie parameters are not supported for request-validator plugin; | ||
| choose either path, query or header`) |
There was a problem hiding this comment.
these backticks will preserve the whitespace and newline for the log message, which is not what we want. Also the message can be a bit clearer about the consequences I think, how about "cookie parameters are not supported by the request-validator plugin; validation will be skipped"
At the moment, we do not support cookie parameters in request-validator plugin. However,
deck file openapi2kongcommand generates the yaml file even if it is present in the parameter schema. Thus, adding a validation layer over it to ensure deck does not create invalid specs.For: #223