[CAMEL-19888] Preserve openapi tags order while generating api-doc

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 4.0.0
• Fix Version/s: 4.0.1, 4.1.0
• Component/s: camel-openapi-java
• Estimated Complexity: Novice
• Assignee: Unassigned
• Reporter: Jakub
• Created: 20/Sep/23 11:21
• Updated: 20/Sep/23 14:10
• Resolved: 20/Sep/23 14:10

Description

In RestOpenApiReader.class, while aggregating the tags for api-doc, the HashMap is used instead of LinkedHashMap, which breaks the original order of the tags:

if (openApi.getTags() != null) {
            openApi.setTags(new ArrayList<>(
                    openApi.getTags()
                            .stream()
                            .collect(Collectors.toMap(
                                 Tag::getName, 
                                 Function.identity(), 
                                 (prev, current) -> prev))
                            .values()));
}

A LinkedHashMap could be used instead:

if (openApi.getTags() != null) {             
            openApi.setTags(new ArrayList<>(
                    openApi.getTags()
                           .stream()
                           .collect(Collectors.toMap(
                               Tag::getName, 
                               Function.identity(), 
                               (prev, current) -> prev,
                               LinkedHashMap::new)
                           .values()));
} 

 

There is no way of sorting the tags after that, and their order influences, for example, the UI of the swagger.