Skip to content

Conversation

AkashKumar7902
Copy link
Contributor

What has changed?

Please include a summary of the change.

This PR Resolves #(issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • Documentation update (if none of the other choices apply).

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:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

@Copilot Copilot AI review requested due to automatic review settings August 5, 2025 12:57
Copy link

keploy bot commented Aug 5, 2025

To generate Unit Tests for this PR, please click here.

Copy link

@Copilot Copilot AI left a 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

Comment on lines +213 to +219
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.

Copy link
Preview

Copilot AI Aug 5, 2025

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.

Suggested change
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.

Comment on lines +215 to +221
Here is the completed "API Reference: Data Structures" section for your documentation, written to be precise and developer-friendly.

Copy link
Preview

Copilot AI Aug 5, 2025

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.

Suggested change
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.

@Achanandhi-M
Copy link
Contributor

Hey @AkashKumar7902 Any update about this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants