-
Notifications
You must be signed in to change notification settings - Fork 1
feat(webhooks & callbacks): add contracts for webhooks and callbacks #37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request adds comprehensive contracts for webhook and callback handling by introducing a signature verification framework and HTTP request modeling. The changes enable language-agnostic webhook implementations across core libraries and SDKs.
- Added signature verification interface with standardized result handling
- Introduced framework-agnostic HTTP request model for webhook processing
- Updated package structure and documentation to reflect new capabilities
Reviewed Changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
setup.py | Version bump from 0.1.6 to 0.1.7 |
apimatic_core_interfaces/security/verification_result.py | New model for standardized verification outcomes |
apimatic_core_interfaces/security/signature_verifier.py | Abstract interface for signature verification implementations |
apimatic_core_interfaces/security/init.py | Package initialization for security module |
apimatic_core_interfaces/http/request.py | Framework-agnostic HTTP request model |
apimatic_core_interfaces/http/init.py | Package initialization for HTTP module |
apimatic_core_interfaces/init.py | Updated main package exports |
README.md | Documentation updates with new interfaces and models |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
…o SignatureVerificationResult
|
What
Why
To provide stable, language-agnostic contracts enabling consistent webhook and callback implementations across core libraries and SDKs.
Closes #36
Type of change
Select multiple if applicable.
Dependency Change
If a new dependency is being added, please ensure that it adheres to the following guideline https://github.com/apimatic/apimatic-codegen/wiki/Policy-of-adding-new-dependencies-in-the-core-libraries
Breaking change
If the PR is introducing a breaking change, please ensure that it adheres to the following guideline https://github.com/apimatic/apimatic-codegen/wiki/Guidelines-for-maintaining-core-libraries
Testing
List the steps that were taken to test the changes
Checklist