You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by "exceptionfactory (via GitHub)" <gi...@apache.org> on 2024/01/11 00:08:49 UTC
[PR] NIFI-12591 Upgrade from Swagger Annotations 1.6.12 to 2.2.20 [nifi]
exceptionfactory opened a new pull request, #8232:
URL: https://github.com/apache/nifi/pull/8232
# Summary
[NIFI-12591](https://issues.apache.org/jira/browse/NIFI-12591) Upgrades Swagger Annotations dependencies and references from 1.6.12 to 2.2.20.
The upgrade aligns component class and property annotations with the Swagger Plugin configuration already implemented supporting OpenAPI 3.0.
For both NiFi and NiFi Registry, the changes support complete API response definitions for all REST Resource classes.
The most visible change is the NiFi REST API documentation, which now uses the standard HTML template from the [Swagger Codegen Maven Plugin](https://github.com/swagger-api/swagger-codegen/tree/v3.0.52/modules/swagger-codegen-maven-plugin) together with custom CSS. This change aligns both the NiFi and NiFi Registry REST API documentation using the same approach. The rendered HTML shows all methods and object definitions in a single HTML page, instead of collapsed sections.
Swagger annotation changes apply to the following modules:
- c2-protocol-api
- c2-protocol-component-api
- minifi-c2-service
- nifi-api
- nifi-client-dto
- nifi-extension-manifest-model
- nifi-registry-revision-entity-model
- nifi-registry-data-model
- nifi-registry-web-api
- nifi-web-api
# Tracking
Please complete the following tracking steps prior to pull request creation.
### Issue Tracking
- [X] [Apache NiFi Jira](https://issues.apache.org/jira/browse/NIFI) issue created
### Pull Request Tracking
- [X] Pull Request title starts with Apache NiFi Jira issue number, such as `NIFI-00000`
- [X] Pull Request commit message starts with Apache NiFi Jira issue number, as such `NIFI-00000`
### Pull Request Formatting
- [X] Pull Request based on current revision of the `main` branch
- [X] Pull Request refers to a feature branch with one commit containing changes
# Verification
Please indicate the verification steps performed prior to pull request creation.
### Build
- [X] Build completed using `mvn clean install -P contrib-check`
- [X] JDK 21
### Licensing
- [ ] New dependencies are compatible with the [Apache License 2.0](https://apache.org/licenses/LICENSE-2.0) according to the [License Policy](https://www.apache.org/legal/resolved.html)
- [ ] New dependencies are documented in applicable `LICENSE` and `NOTICE` files
### Documentation
- [ ] Documentation formatting appears as expected in rendered files
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-12591 Upgrade from Swagger Annotations 1.6.12 to 2.2.20 [nifi]
Posted by "bejancsaba (via GitHub)" <gi...@apache.org>.
bejancsaba closed pull request #8232: NIFI-12591 Upgrade from Swagger Annotations 1.6.12 to 2.2.20
URL: https://github.com/apache/nifi/pull/8232
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-12591 Upgrade from Swagger Annotations 1.6.12 to 2.2.20 [nifi]
Posted by "bejancsaba (via GitHub)" <gi...@apache.org>.
bejancsaba commented on code in PR #8232:
URL: https://github.com/apache/nifi/pull/8232#discussion_r1448703425
##########
nifi-commons/nifi-swagger-integration/src/main/java/org/apache/nifi/swagger/integration/StandardObjectMapperProcessor.java:
##########
@@ -0,0 +1,33 @@
+/*
+ * 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.
+ */
+package org.apache.nifi.swagger.integration;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import io.swagger.v3.oas.integration.api.ObjectMapperProcessor;
+
+/**
+ * Standard Jackson Object Mapper Processor for customizing OpenAPI Specification generation
+ */
+public class StandardObjectMapperProcessor implements ObjectMapperProcessor {
Review Comment:
Thank you, it is nice that Swagger can be customized with this
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org