Array of object doesn't contain name of the object

[peter-busfy-gje]

We have controller, which returns list of objects as response.
We wondered version 2.8.13 shows just array of object (missing real name of the object)

This way we specified it in the code:

@ApiResponses( value = [ApiResponse( responseCode = "200", description = "Successful operation", content = [Content(array = ArraySchema(schema = Schema(implementation = ContactDTO::class)))] )] )

What I assume is correct.
If I downgrade to version 2.7.0 (no other change) everything seems to be ok (ContactDTO is there).

To Reproduce
Steps to reproduce the behavior:

• spring-boot 3.5.5
• doc version:

<dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.8.13</version> </dependency>

• java 21
• kotlin version - 2.2.20
• not sure which other information could be useful. If needed I can add it later

Thank you in advance

[jackwhelpton]

Perfect timing, as I just hit this today too! It's particularly painful for us, because our regression tests use the OpenAPI spec to generate requests, and without type information available they fail.

To avoid this being just a "me too" post, I can confirm this first appears in 2.8.0, so it is necessary to roll back to 2.7.0 for now: earlier 2.8.* releases still fail (we were using 2.8.13).

[Mattias-Sehlstedt]

See #2867 (comment) for the issue and #2867 (comment) for a solution.

[peter-busfy-gje]

thank you @Mattias-Sehlstedt
I can confirm it is working as you described.
Just I haven't found to be mentioned somewhere that in open-api 3.1 it should behave like this.

[jackwhelpton]

I don't understand why this is a 3.1 issue either. I've read through the spec pretty carefully, and it contains myriad examples of a type attribute on the items property of a schema, which is after all just a sub-schema. It still defers to the JSON Schema spec from 2021:

https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-00

and it also details items as a subschema, meaning it should have all the properties of the parent schema (including type).

The linked issue is described as a Swagger UI problem, but this is a code issue for us: we use ExampleBuilder on the schema and its properties to build our test clients, and it will omit any properties with null type.

I don't think this should be closed, as reverting to OpenAPI 3.0 isn't desirable: I don't want to be stuck on older OpenAPI versions.

[peter-busfy-gje]

ok. according @jackwhelpton reopening the issue

[Mattias-Sehlstedt]

@jackwhelpton The issue shown in the original description is merely a change in visualization that has been reported many times, where swagger-ui (a component that is not managed by this project, please find it here) has for some reason elected to not display the schema name when visualizing 3.1 specifications. There have also been an issue raised in that project for it swagger-api/swagger-ui#10501.

My understanding is that if @peter-busfy-gje expands the items list here,

Then we will see all the properties of ContactDTO, it is just that swagger-ui have made it so that it is displayed as array<object> rather than the actual schema name.

There is nothing that can be done in this project for adjusting for the visualization within the human-usable interface.

If you believe the issue is wider than mere visualization, and that the generated specification is invalid. Then please share the controller that is introspected, and its generated specification, so that it will be possible to identify the issue.