NIFI-12298 add swagger annotations for createExtensionBundleVersion form fields #7961
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
NIFI-12298
The current swagger annotations for the
createExtensionBundleVersion function in BucketBundleResource results in the form parameters for 'file' and 'sha256' being left out of the generated swagger api defenition for the /buckets/{bucketId}/bundles/{bundleType} endpoint.
By adding a
ApiImplicitParams annotation for both these fields, swagger will correctly interpret these and add them as fields to the endpoint.
When generating swagger clients, this change is required to correctly support the necessary input arguments.
Swagger defenition of endpoint BEFORE changes:
Swagger definition of endpoint AFTER changes:
Tracking
Please complete the following tracking steps prior to pull request creation.
Issue Tracking
Pull Request Tracking
NIFI-00000
NIFI-00000
Pull Request Formatting
main
branchVerification
Please indicate the verification steps performed prior to pull request creation.
Build
mvn clean install -P contrib-check
Licensing
LICENSE
andNOTICE
filesDocumentation
- [ ] Documentation formatting appears as expected in rendered files