pvillard31 opened a new pull request, #11870:
URL: https://github.com/apache/nifi/pull/11870
# Summary
NIFI-16527 - Move to Swagger 3
### OpenAPI Specification Generation
The OpenAPI specifications for the NiFi and NiFi Registry REST APIs are now
generated with Swagger Core 3. The REST API behavior and the JSON exchanged
over HTTP are unchanged. The generated swagger.json and swagger.yaml files do
have some structural differences. Clients generated from the previous
specifications continue to work against the server. Clients regenerated from
the new specifications will have different generated code in the following
places.
### NiFi REST API
The StreamingOutput schema has been removed. The following operations now
declare their response body as a generic object instead of referencing
StreamingOutput:
- GET
/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files
- GET /flow/metrics/{producer}
- GET /flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content
- GET /provenance-events/{id}/content/input
- GET /provenance-events/{id}/content/output
### NiFi Registry REST API
The shared Link schema has been removed. Link properties are now defined
inline in each schema that uses them, so generated clients no longer contain a
single Link model class for these properties:
- Bucket.link, BucketItem.link, VersionedFlow.link,
VersionedFlowSnapshotMetadata.link
- BundleVersion.link, BundleVersionMetadata.link
- ExtensionMetadata.link, ExtensionMetadata.linkDocs
- ExtensionRepoArtifact.link, ExtensionRepoBucket.link,
ExtensionRepoGroup.link, ExtensionRepoVersionSummary.link
- ExtensionRepoVersion.downloadLink, ExtensionRepoVersion.extensionsLink,
ExtensionRepoVersion.sha256Link
Users maintaining clients generated from these specifications should
regenerate them and update code that references the StreamingOutput or Link
model types.
# Tracking
Please complete the following tracking steps prior to pull request creation.
### Issue Tracking
- [Apache NiFi Jira](https://issues.apache.org/jira/browse/NIFI) issue
created
### Pull Request Tracking
- Pull Request title starts with Apache NiFi Jira issue number, such as
`NIFI-00000`
- Pull Request commit message starts with Apache NiFi Jira issue number, as
such `NIFI-00000`
- Pull request contains [commits
signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)
with a registered key indicating `Verified` status
### Pull Request Formatting
- Pull Request based on current revision of the `main` branch
- 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
- [ ] Build completed using `./mvnw clean install -P contrib-check`
- [ ] JDK 21
- [ ] JDK 25
### 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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
