feat: regenerate API client from OpenAPI spec - #29
Merged
Conversation
![convoy-sdk-reviewer[bot]](https://avatars.githubusercontent.com/u/66191081?s=60&v=4){kind=small}
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
1 participant
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 (ruby) from
docs/v3/openapi3.yamlon frain-dev/convoy main. Hand-written gem code (lib/convoy/, incl. webhook verify) is untouched by the sync script.Note
Medium Risk
Removing
metadatafrom event response models is a breaking API client change for downstream code; otherwise this is generated-model parity with the spec.Overview
Regenerated OpenAPI Ruby models for event payloads so they match the current Convoy API spec (v26.3.5).
DatastoreEventandModelsEventResponsenow exposefailure_reason(operator-facing explanation when status is Failure, without secrets or payload) and no longer includemetadata. Serialization, equality, and hash behavior were updated accordingly.Any gem consumer that read
metadatafrom event API responses must switch to other fields or stop relying on that property;failure_reasonis available for dashboard-style failure messaging.Reviewed by Cursor Bugbot for commit e26d7ec. Bugbot is set up for automated code reviews on this repo. Configure here.