feat(gateway): OAS validation structured errors#5553
Open
lena-larionova wants to merge 2 commits into
Open
Conversation
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the OAS Validation plugin’s new 3.15 structured error reporting options, including a new example config users can apply.
Changes:
- Adds an Error handling section describing
structured_errorsandmax_structured_errorsand how they affect validation error output. - Adds a new plugin example demonstrating how to enable structured validation errors.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| app/_kong_plugins/oas-validation/index.md | Documents structured error output and related parameters for OAS Validation in 3.15. |
| app/_kong_plugins/oas-validation/examples/structured-errors.yaml | Adds a new plugin example enabling structured error reporting. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a section on error handling in the OAS Validation plugin and logs the new params in 3.15.
You can test with the 3.15.0.0-rc.3 image and the following snippet:
Fixes #5414
Preview Links
https://deploy-preview-5553--kongdeveloper.netlify.app/plugins/oas-validation/#error-handling
https://deploy-preview-5553--kongdeveloper.netlify.app/plugins/oas-validation/examples/structured-errors/