-
Notifications
You must be signed in to change notification settings - Fork 222
docs: add webhook documentation #626
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
To generate Unit Tests for this PR, please click here. |
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 PR adds comprehensive webhook documentation for Keploy ATG (Automated Test Generation), specifically focusing on the webhook integration system. The documentation provides developers with the necessary information to implement custom webhook servers that can integrate with Keploy's test execution lifecycle.
- Introduces a complete webhook integration guide with concepts, API reference, and examples
- Provides a working Go server implementation demonstrating webhook handling patterns
- Documents the two-phase webhook system (PreExecute and PostExecute) with detailed data structures
Of course. Since you are not using a separate DTO layer, the documentation must accurately reflect the internal `entModels` that will be serialized directly to JSON. This means exposing all fields as they exist in your Go structs. | ||
|
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.
This paragraph appears to be unrelated content that was accidentally included in the documentation. It references implementation details about DTOs and internal models that don't match the context of the webhook documentation.
Of course. Since you are not using a separate DTO layer, the documentation must accurately reflect the internal `entModels` that will be serialized directly to JSON. This means exposing all fields as they exist in your Go structs. |
Copilot uses AI. Check for mistakes.
Here is the completed "API Reference: Data Structures" section for your documentation, written to be precise and developer-friendly. | ||
|
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.
This sentence appears to be editorial commentary that should not be part of the final documentation. It reads like a note to the reviewer rather than content for end users.
Here is the completed "API Reference: Data Structures" section for your documentation, written to be precise and developer-friendly. |
Copilot uses AI. Check for mistakes.
Signed-off-by: Akash Kumar <[email protected]>
a66061b
to
281b29e
Compare
Hey @AkashKumar7902 Any update about this PR? |
What has changed?
Please include a summary of the change.
This PR Resolves #(issue)
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please run npm run build and npm run serve to check if the changes are working as expected. Please include screenshots of the output of both the commands. Add screenshots/gif of the changes if possible.
Checklist: