[NIFI-12591] Upgrade Swagger Annotations to Version 2

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.0.0-M2
• Component/s: Core Framework
• Assignee: David Handermann
• Reporter: David Handermann
• Created: 09/Jan/24 17:21
• Updated: 11/Jan/24 19:33
• Resolved: 11/Jan/24 19:30

Description

The Swagger Annotations dependency should be upgraded from version 1 to version 2 in order to support OpenAPI Specification Version 3 and Jakarta EE 10.

Recent upgrades for Spring Framework 6 and Jetty 12 required migrating to Jakarata EE 10 libraries, including the newer version of the Swagger Maven Plugin. The initial migration did not incorporate upgrading the Swagger Annotations because it requires adjusting all current REST API resource annotations. Most of the changes are similar, but some restructuring is required.

These changes are necessary so that the generated OpenAPI specification, and REST API documentation, will reflect the full object definitions on responses.

Issue Links

• fixes: NIFI-12512 NiFi Registry swagger has no paths
• is related to: NIFI-11703 Upgrade Spring Framework to version 6
• links to: GitHub Pull Request #8232