Is it pedantic or does the order of elements matter?

[lachlan-00]

The open API spec puts items in a different order to the documents.

does this matter? because my responses all follow the documents and there is a discrepancy between the 2.

[Tolriq]

Order does not matter.

[paulijar]

Yeah, if someone makes any assumptions about the order of the fields within a JSON object, then they are doing it wrong. JSON array is obviously a different story as it's an ordered container. Where things get a bit muddy are the XML responses since the XML syntax doesn't make a clear distinction between unordered dictionary-type structures and ordered list-type structures. But even there, it's a reasonable assumption that any repeating elements form a list where the order matters and unrepeating elements are just key-value pairs without a defined order.

That being said, there would be some value in keeping the order in sync between the documentation and the OpenAPI: It would make it easier to check that the two are aligned, containing all the same properties. I wouldn't care enough to make a PR for such changes, but if someone makes such a PR, I would approve it.

[Tolriq]

Pretty sure @deluan can ask Claude to do that easily :p

[deluan]

I sure can, and this is the perfect thing to use AI for :)
But I don't have time to review it. Here's the PR: #207

[lachlan-00]

I'll give it some time to review manually asap, I'm checking out my own responses right now so that's easy enough to do at the same time