Swagger-core: Swagger2 breaks manual positioning

[chadjaros]

I'd like to preserve manual positioning after the transition from 1.2 to 2. The Swagger object seems to allow order preserving insertion for paths, but then it does a manual sort prior to retrieval.

I feel like the position parameter on the @ApiOperation and @Api annotation either needs to be deprecated, or the Swagger 2.0 model should honor that ordering. I'd prefer the latter.

[webron]

https://github.com/swagger-api/swagger-core/blob/develop_2.0/modules/swagger-annotations/src/main/java/com/wordnik/swagger/annotations/ApiOperation.java#L94-L98
https://github.com/swagger-api/swagger-core/blob/develop_2.0/modules/swagger-annotations/src/main/java/com/wordnik/swagger/annotations/Api.java#L76-L82

They _are_ deprecated. Unfortunately the javadocs were not updated in previous released but will be in the next one.

[chadjaros]

Cool. Thanks for the info.

[exstan]

So how should I order my methods when the 'position' attribute is deprecated?
As I'm using swagger-maven-plugin (JAX-RS) and I want a custom order of my methods in the swagger.json.

[webron]

It's not an array, so you can't really guarantee order.

[exstan]

So, it was possible with the 'position' attribute but now it is not :) perfect

[webron]

In Swagger 1.2 operations were an array. In 2.0 they're not.

[chadjaros]

Sets and maps both have order-preserving implementations in Java. See LinkedHashSet and LinkedHashMap

[webron]

They do. In JSON parsing, order of object's properties order is not guaranteed.

[exstan]

But if the 'position' attribute is also exported in the JSON, the order will be guaranteed again.

[webron]

Yes, but there's no position attribute in the spec, so it can't be exported.

[webron]

Closing for now, Please reopen as needed.

[sschwell]

+1 on this as a important loss of functionality.
If the spec needs to change, then so be it. Its really important to be able to specify an order for Resources and Operations.

[webron]

@sschwell - the spec is not going to change any time soon to support it. The order of resources _can_ be controlled based on the order of the tags as you declare them. The order of the operations can't.

[Chinna-SHS]

Is there any option to set the order of API methods @ApiOperation annotation?

[webron]

As said, not during generation. You can potentially change the order in display if the tools allow it.

[knivesss]

Sounds like some BS, removed important feature with no care to fix.