OpenAPITools / OpenAPITools/openapi-generator

[REQ] Feature Request Description

Open
#9,718 1 comment 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

I am stuck at a point in my Open API development where I am not able to define custom validation messages for field level validations in my schema

When I define an OPEN API schema like below, I want to be able to define a custom validation message as well

ssn:
  type: string
  pattern: '^\d{3}-\d{2}-\d{4}$

At the moment the only alternative is to do all the validation outside of the Open API spec and put in into Java code

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

Start with the OpenAPI schema example and investigate how the pattern validation is represented in generated Java code. The change would be complete when a custom field-level validation message can be declared in the OpenAPI schema and is preserved in the generated validation behavior.

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.