feat: regenerate API client from OpenAPI spec - #30
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 (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
The renamed config field is a breaking change for Ruby SDK users, and both settings affect dynamic event ingestion behavior when sent to the API.
Overview
Regenerated OpenAPI Ruby models for project config (
DatastoreProjectConfigandModelsProjectConfig) to match the updated Convoy API spec.New field:
allow_unmatched_dynamic_urls— when enabled, dynamic event URLs that do not match any endpoint URL template can auto-create an endpoint; defaultfalserejects unmatched URLs when templates exist.Breaking rename:
sync_dynamic_event_ackis replaced byverify_dynamic_events(same JSON key change on the wire). It still controls whetherPOST /events/dynamicwaits for endpoint/subscription resolution before returning 2xx vs returning 201 after enqueue.Callers of the Ruby client must migrate from
sync_dynamic_event_acktoverify_dynamic_eventswhen reading or writing project configuration.Reviewed by Cursor Bugbot for commit 7f43f50. Bugbot is set up for automated code reviews on this repo. Configure here.