OpenAPITools / OpenAPITools/openapi-generator

[REQ] Example validation in OpenApi definition

Open
#14,101 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Describe the solution you'd like

Validation of examples declared in yaml definition. I would like to declare an example that is checked with schema defined in API response definition.

Additional context

https://stackoverflow.com/questions/74546598/openapi-generator-is-it-possible-to-declare-schema-of-example

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by tracing how OpenAPI YAML examples and API response schemas are parsed and validated, then review the linked Stack Overflow context. Done means declared examples are checked against the response schema, with coverage for valid and invalid examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.