Chaffelson commented on PR #10957: URL: https://github.com/apache/nifi/pull/10957#issuecomment-3999778093
## nipyapi Client SDK Impact Assessment I maintain nipyapi (https://github.com/Chaffelson/nipyapi), a Python client SDK generated from NiFi's swagger spec. I've built nifi-web-api from this PR branch and regenerated the client to assess impact. ### Summary The annotation changes produce two breaking changes to the generated client method signatures: - search_flow() - q parameter now required (was optional) - import_process_group() - body parameter now required and moved to first position ### Details FlowResource.searchFlow - The new @Parameter annotations on q and a query params cause q to become a required positional argument in the generated client. Previously callers could omit it. ProcessGroupResource.importProcessGroup - The new @Parameter(description=..., required=true) on the body causes it to become required and reordered to first position. ### Assessment These changes are arguably correct - you can't meaningfully search without a query term, and you can't import without a body. But they will break existing SDK callers who relied on the previous optional behavior. The @FormDataParam to @FormParam migration doesn't affect the swagger spec output (both produce type: object for the file parameter), so that's fine from a client generation perspective. ### Recommendation No changes requested - the breaking changes reflect correct API semantics. Just flagging for awareness that downstream SDK users may need to update their code. -- 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]
