Objects properties order is not preserved with springdoc.api-docs.resolve-schema-properties = true

[jawpio]

For some projects the object properties order is not preservered in the schema.

I checked the sample-springdoc-openapi-person-service if I change the Person properties order it's reflected in the swagger specification.

I created a minimalistic project which shows that the properties order is not preserved https://github.com/jawpio/springdoc-property-ordering-test.

In above project you can see that the SampleResponseClass looks as follows:

public class SampleResponseClass {

	private String id;

	private String name;

	private String lastName;

	private boolean aValue;

but it's generated as:

      "SampleResponseClass": {
        "type": "object",
        "properties": {
          "lastName": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "isaValue": {
            "type": "boolean"
          }
        }
      }

I tired to find what's causing that issue, but I was unable to find the reason yet.

[jawpio]

I found the what's causing above problem, setting the property:
springdoc.api-docs.resolve-schema-properties = true

has that side effect.

[bnasslahsen]

@jawpio,

There is no such expected order.
If you want a deterministic/alphabetical order, use springdoc.writer-with-order-by-keys= true as described in the documentation.

[jawpio]

Thanks @bnasslahsen for answer, but I think the issue should be still opened.

The springdoc.writer-with-order-by-keys=true setting orders properties alphabetically which is not something we want to achieve, we'd like to keep/preserve properties order from the java model.

Please note that, with default springdoc/swagger configuration properties order is(and should be) preserved! Check all examples etc.!

The problem starts when you set the springdoc.api-docs.resolve-schema-properties to true, than the properties order is not preserved. Due to the fact it's the springdoc.api-docs.* configuration which is causing the issue I think the problem is somewhere in springdoc.

IMO properties order is important aspect in documentation description, you don't want to put items which are less relevant on the top of the object description.
Other thing is that when you describe the XML responses, quite often you'd like to keep XSD schema compatibility for legacy projects, and please note that <xsd:sequence> from XSD schema enforces the properties order.

[bnasslahsen]

@jawpio,

Make sure you Provide a Minimal, Reproducible Example - with HelloController that reproduces the problem which proves your affirmation.

This ticket can be reopened, if the relevant information are provided.

[jawpio]

@bnasslahsen Thanks for quick answer!

Please check this project https://github.com/jawpio/springdoc-property-ordering-test I think it's as minimalistic as possible, and please check the ReadMe to reproduce the issue.