David Handermann created NIFI-9630:
--------------------------------------
Summary: Migrate NiFi Registry to swagger-codegen-maven-plugin
Key: NIFI-9630
URL: https://issues.apache.org/jira/browse/NIFI-9630
Project: Apache NiFi
Issue Type: Improvement
Components: NiFi Registry
Reporter: David Handermann
Assignee: David Handermann
NiFi Registry REST API documentation uses a combination of the
{{swagger2markup-maven-plugin}} and the {{asciidoctor-maven-plugin}} to
generate the REST API documentation HTML for embedding and publication. The
[Swagger2Markup|https://github.com/Swagger2Markup/swagger2markup] project is no
longer maintained, and the last version was released in 2018. In addition, the
transitive dependencies for Swagger2Markup are no available in Maven Central,
but can be found in the read-only JCenter repository.
The [Swagger
Codegen|https://swagger.io/docs/open-source-tools/swagger-codegen/] library,
and associated Maven plugin, support generating static HTML documentation from
Swagger definitions. The library and Maven plugin are actively maintained and
provides a replacement for the current REST API documentation approach in NiFi
Registry. Although the styling is different than the current approach, the
generated HTML contains the same information.
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
