Skip to content

feat(gateway): OAS validation structured errors#5553

Open
lena-larionova wants to merge 2 commits into
release/gateway-3.15from
feat/oas-structured-errors
Open

feat(gateway): OAS validation structured errors#5553
lena-larionova wants to merge 2 commits into
release/gateway-3.15from
feat/oas-structured-errors

Conversation

@lena-larionova

@lena-larionova lena-larionova commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

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:

curl -i -X POST http://localhost:8001/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "oas-validation",
      "config": {
        "api_spec": "openapi: 3.0.0\ninfo:\n  title: Sample API\n  version: 1.0.0\npaths:\n  /test:\n    get:\n      responses:\n        \"200\":\n          description: OK",
        "structured_errors": true,
        "max_structured_errors": 10,
        "verbose_response": true
      },
      "tags": []
    }
    '

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/

Copilot AI review requested due to automatic review settings June 11, 2026 21:06
@lena-larionova lena-larionova requested a review from a team as a code owner June 11, 2026 21:06
@netlify

netlify Bot commented Jun 11, 2026

Copy link
Copy Markdown

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit 9145cc9
🔍 Latest deploy log https://app.netlify.com/projects/kongdeveloper/deploys/6a2b27cc7a73560008b65bcc
😎 Deploy Preview https://deploy-preview-5553--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_errors and max_structured_errors and 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.

Comment thread app/_kong_plugins/oas-validation/index.md Outdated
Comment thread app/_kong_plugins/oas-validation/examples/structured-errors.yaml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants