OpenAPITools / OpenAPITools/openapi-generator

[BUG][JAVA][KOTLIN] referencing a pattern makes the type to object/any

Open
#16,139 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

Referencing a pattern for a property or path parameter makes the type an Object/Any instead of String
Example of the kotlin spring generator. The property s is of type Any.

    @field:Valid
    @get:Pattern(regexp="^EXTID:[\\w\\-_]*$")
    @Schema(example = "null", required = true, description = "")
    @get:JsonProperty("s", required = true) val s: kotlin.Any,
openapi-generator version

6.6.0

OpenAPI declaration file content or url

Example schema:

{
	"schemas": {
		"example_pattern": {
			"pattern": "^example"
		},
		"example_object": {
			"type": "object",
			"properties": {
				"s": {
					"type": "string",
					"$ref": "#/components/schemas/example_pattern"
				}
			}
		}
	}
}
Generation Details

tested with java-jaxrs and kotlin spring

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 by reproducing the supplied schema with the java-jaxrs and kotlin-spring generators, focusing on the property or path-parameter type produced when a pattern schema is referenced. Trace how the referenced schema's pattern and string type are resolved, then verify that the generated property is String rather than Object or Any.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, kotlin
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.