feat: regenerate API client from OpenAPI spec - #22
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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
Public generated method signatures change: Events API methods insert a new
$bodyargument, which can break positional callers. Delivery methods only add a trailing optional$query, which is safer.Overview
Regenerates generated Convoy PHP client APIs from the latest OpenAPI spec so list/replay/retry calls can send the new search filters.
Events (
EventsApi):getEventsPaged,batchReplayEvents, andcountAffectedEventstake an optionalbodyquery param (URL-encoded JSON payload match, ANDed withquery).querydocs now describe id/idempotency/type/source matching plus JSON containment. This inserts$bodyas the second positional argument, so positional callers of those methods will shift remaining args.Deliveries (
EventDeliveriesApi):getEventDeliveriesPagedandbatchRetryEventDeliverygain optionalquery(delivery id, event id, event type prefix, endpoint name).List endpoints also map 504 (and events list 403) to the existing error model.
DatastoreProjectConfig.search_policydocs describe the optional lookback duration for payload search.Reviewed by Cursor Bugbot for commit eb90f6b. Bugbot is set up for automated code reviews on this repo. Configure here.