Skip to content

Added Test Operations - share, improve#587

Merged
nehagup merged 1 commit intomainfrom
operations
Jun 23, 2025
Merged

Added Test Operations - share, improve#587
nehagup merged 1 commit intomainfrom
operations

Conversation

@TvisharajiK
Copy link
Contributor

This pull request introduces new documentation for Keploy's API test suite features, including reviewing, improving, and sharing AI-generated tests, along with updates to the sidebar structure to accommodate these additions.

New Documentation:

Sidebar Updates:

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 AI review requested due to automatic review settings June 23, 2025 17:53
Copy link

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 new documentation pages for reviewing, improving, and sharing Keploy AI-generated API test suites, and updates the sidebar to surface these new guides under a "Test Operations" category.

  • Introduce Review & Improve AI-Generated API Tests guide
  • Introduce Share Test Suite With Your Team guide
  • Update sidebars JSON to include new "Test Operations" category

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.

File Description
versioned_sidebars/version-3.0.0-sidebars.json Added new "Test Operations" category under running-keploy
versioned_docs/version-3.0.0/running-keploy/share-tests.md New doc explaining how to share test suites
versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md New doc for reviewing and editing AI-generated tests
Comments suppressed due to low confidence (6)

versioned_docs/version-3.0.0/running-keploy/share-tests.md:5

  • The frontmatter description still refers to generating tests rather than sharing them. Update it to reflect sharing test suites with team members.
description: Learn how to use Keploy’s API Test Generator to generate high-quality API test suites using AI from OpenAPI, curl, Postman, or traffic.

versioned_docs/version-3.0.0/running-keploy/share-tests.md:26

  • The bullet overflows across two lines. Combine "An email" and "with a direct link to the suite" into a single list item for better readability.
- An email 

versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md:12

  • [nitpick] Consider rephrasing for clarity, e.g., "Select an application to view its generated test suite."
Based on the app that is selected, you can view the test suite for that app

versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md:24

  • Use the conventional abbreviation "e.g.," instead of "eg:".
You can **combine these filters** with the search bar—for example, view only failed `DELETE` calls on eg: `/employees`—making it painless to triage huge test suites.

versioned_sidebars/version-3.0.0-sidebars.json:17

  • The JSON indentation and comma placement around the new category objects is inconsistent and may break parsing. Align braces and commas with existing entries and remove extra blank lines for clarity.
        },

versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md:55

  • There are two spaces after ##; reduce to one for consistent heading formatting.
##  Edit or Delete a Test Suite

@nehagup nehagup merged commit 6f07c2b into main Jun 23, 2025
1 check passed
@nehagup nehagup deleted the operations branch June 23, 2025 18:50
nehagup pushed a commit that referenced this pull request Jun 23, 2025
nehagup pushed a commit that referenced this pull request Jun 23, 2025
nehagup added a commit that referenced this pull request Jun 23, 2025
* docs: adding atg public docs for installation and explanation

Signed-off-by: Neha Gupta <gneha21@yahoo.in>

* docs: adding atg public docs for fix with ai

Signed-off-by: Neha Gupta <gneha21@yahoo.in>

* chore: atg operations (#587)

* chore: atg operations (#587)

* docs: adding atg public docs for fix with ai

Signed-off-by: Neha Gupta <gneha21@yahoo.in>

---------

Signed-off-by: Neha Gupta <gneha21@yahoo.in>
Co-authored-by: Tvisha <tvisha.raji@keploy.io>
che3zcake pushed a commit to che3zcake/keploy-docs that referenced this pull request Jun 23, 2025
Signed-off-by: Lawrence Sharma <che3zcake@gmail.com>
che3zcake pushed a commit to che3zcake/keploy-docs that referenced this pull request Jun 23, 2025
* docs: adding atg public docs for installation and explanation

Signed-off-by: Neha Gupta <gneha21@yahoo.in>

* docs: adding atg public docs for fix with ai

Signed-off-by: Neha Gupta <gneha21@yahoo.in>

* chore: atg operations (keploy#587)

* chore: atg operations (keploy#587)

* docs: adding atg public docs for fix with ai

Signed-off-by: Neha Gupta <gneha21@yahoo.in>

---------

Signed-off-by: Neha Gupta <gneha21@yahoo.in>
Co-authored-by: Tvisha <tvisha.raji@keploy.io>
Signed-off-by: Lawrence Sharma <che3zcake@gmail.com>
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.

3 participants