Honor @JsonTypeInfo @JsonTypeName

[sakibulalam]

Problem/Issue:
I have a class annotated with @JsonTypeInfo to define a wrapper property. But it seems it's not being honored when generating the spec yaml/json. This is a mismatch with the actual API response.

@Schema(name = "ErrorResponse")
@JsonTypeName(value = "error")
@JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT, use = JsonTypeInfo.Id.NAME)
data class ErrorResponse(
    val message: String,
    val details: List<String>? = null
)

The produced output is

...
components:
  schemas:
    ErrorResponse:
      required:
      - message
      type: object
      properties:
        details:
          type: object
        message:
          type: string
...

The expected output should be

...
components:
  schemas:
    ErrorResponse:
      required: 
        - error
      properties:
        error:
          required:
          - message
          type: object
          properties:
            details:
              type: array
              items:
                type: string
            message:
              type: string
...

Solution:
When resolving the schema of the classes, the resolver should honor the @JsonTypeInfo, @JsonTypeName annotation

Alternatives:
Right now the only solution I see is to add an additional wrapper class to get it to generate accurate yaml/json.

[bnasslahsen]

@sakibulalam,

This request is not related to springdoc-openapi.
There no direct usage of @JsonTypeInfo and @JsonTypeName by the code of springdoc-openapi.

We rely on swagger-core which generates the correct mapping of objects.
There is already know issue about Json wrapper objects:

• JSON wrapper object not mapped to proper OpenAPI model swagger-api/swagger-core#2884

And you can alternatively, use your workaround.