feat: regenerate API client from OpenAPI spec - #21
Conversation
![convoy-sdk-reviewer[bot]](https://avatars.githubusercontent.com/u/66191081?s=60&v=4){kind=small}
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Want higher recall? High effort reviews run extra passes and find more bugs. A team admin can switch effort levels in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit bc7edec. Configure here.
| * @return \Convoy\Client\Model\BatchReplayEvents200Response|\Convoy\Client\Model\GetProjects400Response|\Convoy\Client\Model\GetProjects400Response|\Convoy\Client\Model\GetProjects400Response | ||
| */ | ||
| public function batchReplayEvents($project_id, $direction = null, $end_date = null, $endpoint_id = null, $idempotency_key = null, $next_page_cursor = null, $per_page = null, $prev_page_cursor = null, $query = null, $sort = null, $source_id = null, $start_date = null, string $contentType = self::contentTypes['batchReplayEvents'][0]) | ||
| public function batchReplayEvents($project_id, $body = null, $direction = null, $end_date = null, $endpoint_id = null, $idempotency_key = null, $next_page_cursor = null, $per_page = null, $prev_page_cursor = null, $query = null, $sort = null, $source_id = null, $start_date = null, string $contentType = self::contentTypes['batchReplayEvents'][0]) |
There was a problem hiding this comment.
New body param shifts arguments
High Severity
Inserting optional $body as the second positional argument on batchReplayEvents, countAffectedEvents, and getEventsPaged (and their WithHttpInfo/Async/Request variants) remaps every later argument. Existing positional callers send filters on the wrong query keys, so listing can miss events and batch replay can target the wrong set.
Additional Locations (2)
Reviewed by Cursor Bugbot for commit bc7edec. Configure here.
4720208
bc7edec to
4720208
Compare
|
SDK reviewer app: not auto-approving; the PR head is not the commit this generation run pushed. Left for human review (policy: fail open to human review, never to merge). |
Automated regeneration via OpenAPI Generator (php) from
docs/v3/openapi3.yamlon frain-dev/convoy main. Hand-written SDK code (src/outsidesrc/Client/, incl. webhook verify) is untouched by the sync script.Note
Medium Risk
SDK method signatures change by inserting a new positional
$bodyparameter, which can silently remap arguments for existing positional callers. No auth or data-store logic is modified.Overview
Regenerates the PHP Events client so list, batch replay, and count-affected-events can send a
bodyquery param (URL-encoded JSON payload containment) alongsidequery.Breaking for positional callers:
$bodyis inserted as the second argument ongetEventsPaged,batchReplayEvents,countAffectedEvents, and their HttpInfo/async/request variants, shifting later optional args.querydocs now describe id/idempotency/type/source matching vs payload JSON.getEventsPagedalso maps 403 and 504 to the existing error model.DatastoreProjectConfig::setSearchPolicydocs now describe the optional lookback duration for payload search.Reviewed by Cursor Bugbot for commit bc7edec. Bugbot is set up for automated code reviews on this repo. Configure here.