kevdoran commented on a change in pull request #5145: URL: https://github.com/apache/nifi/pull/5145#discussion_r650013517
########## File path: nifi-versioned-components/pom.xml ########## @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.nifi</groupId> + <artifactId>nifi</artifactId> + <version>1.14.0-SNAPSHOT</version> + </parent> + + <artifactId>nifi-versioned-components</artifactId> + + <profiles> + <profile> + <id>nifi-versioned-components_jigsaw</id> + <activation> + <jdk>(1.8,)</jdk> + </activation> + <dependencies> + <dependency> + <groupId>javax.xml.bind</groupId> + <artifactId>jaxb-api</artifactId> + </dependency> + </dependencies> + </profile> + </profiles> + + <!-- This module should kept to having no dependencies --> + <dependencies> + <dependency> + <groupId>io.swagger</groupId> + <artifactId>swagger-annotations</artifactId> + <version>1.5.16</version> + <scope>provided</scope> Review comment: Maybe it makes sense to just not include nifi-versioned-components in nifi-api, to avoid the transitive dependency issue? Do they have to be combined? If not, anyone who need the nifi-versioned-components data model can depend on that and deal with the transitive dependency issue. ########## File path: nifi-versioned-components/pom.xml ########## @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.nifi</groupId> + <artifactId>nifi</artifactId> + <version>1.14.0-SNAPSHOT</version> + </parent> + + <artifactId>nifi-versioned-components</artifactId> + + <profiles> + <profile> + <id>nifi-versioned-components_jigsaw</id> + <activation> + <jdk>(1.8,)</jdk> + </activation> + <dependencies> + <dependency> + <groupId>javax.xml.bind</groupId> + <artifactId>jaxb-api</artifactId> + </dependency> + </dependencies> + </profile> + </profiles> + + <!-- This module should kept to having no dependencies --> + <dependencies> + <dependency> + <groupId>io.swagger</groupId> + <artifactId>swagger-annotations</artifactId> + <version>1.5.16</version> + <scope>provided</scope> Review comment: Yeah, I am not aware of future plans for this data model. I just figured that of course every existing use of the versioned components data model must be OK with that transitive dependency, so why not just separate them from nifi-api... Of course that might not be the case forever, but given the motivation is code reuse, I'm just trying to avoid a solution that involves duplicating this data model to have one annotated version and one non-annotated. The swagger annotations in Registry are not just used for REST API documentation. The swagger.json file that is generated from these annotations are used in three places: - To generate the HTML REST API doc (could be done via Enunciate) - By a self-hosted Swagger UI that is dynamically generated based on the contents of swagger.json - In clients that use swagger-codegen to generate REST API client sdks from this spec. Currently this includes [nipyapi](https://github.com/Chaffelson/nipyapi), but I believe there was also talk of replacing much of the nifi-registry-web-ui data model with TypeScript generated from the REST API swagger spec. I'm not opposed to having a separate DTO model that can support annotations and internal model of POJOs, and mappers/converters between them, if that is the only way to satisfy current and future needs. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
