Skip to content

Commit e00f5b6

Browse files
fix: faqs page alignment issues (#600)
Signed-off-by: Achanandhi-M <[email protected]> Co-authored-by: Neha Gupta <[email protected]>
1 parent d56de0e commit e00f5b6

File tree

3 files changed

+147
-48
lines changed

3 files changed

+147
-48
lines changed

versioned_docs/version-3.0.0/keploy-explained/api-testing-faq.md

Lines changed: 62 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ tags:
1010

1111
# Got Questions? We’ve Got Answers! 🚀
1212

13-
Everything you want to know about API testing with Keploy—straightforward and no fluff.
13+
Let's get to the heart of Keploy API Testing with some fun Q&A!
1414

1515
### 1. What types of API tests can Keploy generate?
1616

1717
Keploy automatically creates:
1818

19-
- **Functional Tests:** CRUD operations, endpoint validation
20-
- **Edge Case Tests:** Invalid payloads, error responses
21-
- **Performance Tests:** Response time checks
22-
- **Security Tests:** Input sanitization, auth validation
23-
- **Dependency Tests:** Mocked external service calls
19+
- **Functional Tests** CRUD operations, endpoint validation
20+
- **Edge Case Tests** Invalid payloads, error responses
21+
- **Performance Tests** Response time checks
22+
- **Security Tests** Input sanitization, auth validation
23+
- **Dependency Tests** Mocked external service calls
2424

2525
### 2. How does Keploy handle authentication in API tests?
2626

2727
Keploy supports:
2828

2929
- **Auth Types:** JWT, OAuth2, API Keys, Basic Auth
30-
- **Auto-Renewal:** Token refresh flows
31-
- **Test Isolation:** Separate auth contexts per test
32-
- **Security:** No raw credentials stored—uses environment variables
30+
- **Token Refresh:** Auto-renews tokens as needed
31+
- **Test Isolation:** Uses separate auth contexts per test
32+
- **Secure Storage:** No raw credentials stored—uses environment variables
3333

3434
### 3. What protocols and formats does Keploy support?
3535

@@ -44,14 +44,63 @@ Keploy supports:
4444

4545
Keploy handles stateful workflows by:
4646

47-
1. Recording session cookies/headers
48-
2. Detecting data dependencies between calls
49-
3. Generating cleanup steps (teardown)
50-
4. Creating isolated test contexts
47+
1. Capturing session cookies and headers
48+
2. Detecting request dependencies
49+
3. Creating cleanup/teardown steps
50+
4. Isolating test contexts
5151

5252
**Example:**
5353
`POST /cart → GET /cart → POST /checkout → GET /order/{id}`
5454

55+
### 5. How does Keploy ensure security and compliance?
56+
57+
- **Encryption:** All data is encrypted in transit and at rest
58+
- **Principle of Least Privilege:** Minimum necessary access to data
59+
- **Redundancy:** Fault-tolerant and resilient infrastructure
60+
- **Audits:** Regular security assessments
61+
- **Compliance:** ISO 27001, SOC 2, GDPR, HIPAA
62+
63+
### 6. How does Keploy protect my API data and test traffic?
64+
65+
- No data shared with third parties
66+
- Full transparency about data handling
67+
- Test data is used only for your tests
68+
- Keploy never mines or analyzes your test data for AI training or marketing
69+
70+
### 7. Does Keploy use my data to train AI models?
71+
72+
No. Keploy does **not** use your API data, requests, responses, or logs to train any AI model—internal or external.
73+
74+
### 8. How does Keploy use AI for API testing?
75+
76+
Keploy combines multiple AI models:
77+
78+
- **Gemini 2.5 Pro (Google):** For reasoning and flow understanding
79+
- **GPT-4 (OpenAI):** For robust coverage and complex scenario handling
80+
- **Other LLMs:** Added based on task fit and ongoing evaluation
81+
82+
**How It Works:**
83+
84+
- Smart routing of tasks to the best model
85+
- Tests are validated and cleaned up before output
86+
- Weak or redundant tests are filtered out
87+
88+
### 9. Can I see which model Keploy used for test generation?
89+
90+
We select models automatically, but always prioritize reliability, privacy, and quality. Your code or test data is **never** used to train models.
91+
92+
### 10. What privacy controls do I have?
93+
94+
- You can delete your test data at any time
95+
- All logs, requests, and test artifacts are encrypted
96+
- Keploy gives you full visibility and control
97+
98+
### 11. Want to know more?
99+
100+
Have questions or need a security report for your team? [Contact us!](mailto:[email protected])
101+
102+
Your code, your data, your control. 🔐
103+
55104
Hope this helps you out, if you still have any questions, reach out to us .
56105

57106
import GetSupport from '../concepts/support.md'

versioned_docs/version-3.0.0/keploy-explained/unit-testing-faq.md

Lines changed: 74 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,40 +9,97 @@ tags:
99

1010
# Got Questions? We’ve Got Answers! 🚀
1111

12-
Everything you want to know about Unit testing with Keploy—straightforward and no fluff.
12+
Let's get to the heart of Keploy Unit Testing with some fun Q&A!
1313

1414
### 1. What is Keploy's Unit Test Generator (UTG)?
1515

16-
Keploy's UTG automates the creation of unit tests based on code semantics, enhancing test coverage and reliability.
16+
Keploy's UTG automatically creates unit tests using code semantics and AI. It helps improve code coverage and catch bugs early, with minimal manual effort.
1717

18-
### 2. Does Keploy send your private data to any cloud server for test generation?
18+
### 2. Does Keploy send my code to the cloud?
1919

20-
No, Keploy does not send any user code to remote systems, except when using the unit test generation feature. When using the UT gen feature, only the source code and the unit test code will be sent to the Large Language Model (LLM) you are using. By default, Keploy uses - litellm to support vast number of LLM backends. Yes, if your organization has its own LLM(a private one), you can use it with Keploy. This ensures that data is not sent to any external systems.
20+
Only when using the Unit Test Generator feature—and even then, just the necessary code/test context is sent to the LLM (Large Language Model) you're using. You can also plug in your **own private LLM**, keeping everything within your infrastructure.
2121

22-
### 3. How does Keploy contribute to improving unit test coverage?
22+
### 3. Is my code or data used to train AI models?
2323

24-
By providing a zero code platform for automated testing, Keploy empowers developers to scale up their unit test coverage without extensive coding knowledge. This integration enhances testing reports, ultimately boosting confidence in the product's quality.
24+
No. Never. Keploy does **not** use your code, test cases, or data to train any internal or external AI models.
2525

26-
### 4. Is Keploy cost-effective for automated unit testing?
26+
### 4. Which AI models does Keploy support?
2727

28-
Yes, Keploy optimizes costs by automating repetitive testing tasks and improving overall test efficiency.
28+
Keploy supports:
2929

30-
### 5. How does Keploy generate coverage reports?
30+
- **Gemini 2.5 Pro (Google)**
31+
- **GPT-4 family (OpenAI)**
32+
- **Other specialized models**
3133

32-
Keploy generates detailed Cobertura format reports, offering insights into test effectiveness and code quality.
34+
We route test generation tasks to the model best suited for each case, and validate results to ensure high-quality tests.
3335

34-
### 6. Can Keploy handle large codebases efficiently?
36+
### 5. How does Keploy protect my data?
3537

36-
Yes, Keploy is designed to handle large codebases efficiently, though processing time may vary based on project size and complexity.
38+
Keploy follows strict security practices:
3739

38-
### 7. Which method should I choose for generating unit tests?
40+
- Data is encrypted in transit and at rest
41+
- No data is shared with third parties
42+
- We are compliant with **ISO 27001**, **SOC 2**, **GDPR**, and **HIPAA**
3943

40-
- **PR Agent**: Best for teams using pull request workflows who want automatic test generation
41-
- **VS Code Extension**: Ideal for individual developers who prefer IDE integration
44+
### 6. What kind of privacy guarantees does Keploy offer?
4245

43-
### 8. Do I need an API key to use these two methods?
46+
- Your code is **never shared** or analyzed for marketing
47+
- All data is fully encrypted
48+
- You can delete your data anytime
49+
- Full transparency in how we handle your information
4450

45-
The API key is primarily required for the Command Line method. The PR Agent and VS Code Extension may have different authentication mechanisms depending on your setup.
51+
### 7. Which languages are supported for AI-powered test generation?
52+
53+
-**Go (Golang)**: Full support for generating, running, and validating tests.
54+
- 🚀 **JavaScript** support is coming soon.
55+
56+
We only keep tests that pass, build, and increase coverage—everything else is discarded.
57+
58+
### 8. How does Keploy improve unit test coverage?
59+
60+
By automating the hard parts. Keploy:
61+
62+
- Creates tests automatically
63+
- Targets edge cases
64+
- Filters flaky or redundant tests
65+
- Reports coverage via **Cobertura** format
66+
67+
### 9. Is Keploy suitable for large codebases?
68+
69+
Yes! Keploy is built to handle large, complex projects. Processing time may vary based on size, but the output remains optimized.
70+
71+
### 10. Which method should I use to generate tests?
72+
73+
- **PR Agent**: Best for automated test generation on GitHub pull requests.
74+
- **VS Code Extension**: Ideal for developers who prefer working in their IDE.
75+
- **CLI Tool**: For those who want more control or integrate into scripts.
76+
77+
### 11. Do I need an API key?
78+
79+
Only for the CLI method. Other tools like PR Agent and VS Code Extension use their own secure auth flows.
80+
81+
### 12. How does Keploy ensure the quality of generated tests?
82+
83+
- We validate every test: it must build, pass, and increase coverage.
84+
- Tests that don’t add value are automatically removed.
85+
- We focus on **fewer, stronger** tests—not noise.
86+
87+
### 13. How is Keploy secure and compliant?
88+
89+
Keploy is built on:
90+
91+
- **End-to-end encryption**
92+
- **Least privilege access**
93+
- **Redundant infrastructure**
94+
- Regular **security audits**
95+
96+
We’re committed to keeping your trust.
97+
98+
### 14. What’s next for Keploy?
99+
100+
- Expanding support for more languages
101+
- More model choices for users
102+
- Deeper IDE and CI/CD integrations
46103

47104
Hope this helps you out, if you still have any questions, reach out to us .
48105

versioned_sidebars/version-3.0.0-sidebars.json

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"collapsed": false,
1414
"items": [
1515
"running-keploy/generate-api-tests-using-ai",
16-
"running-keploy/api-testing-chrome-extension"
16+
"running-keploy/api-testing-chrome-extension"
1717
]
1818
},
1919
{
@@ -30,14 +30,9 @@
3030
]
3131
},
3232
{
33-
"type": "category",
33+
"type": "doc",
3434
"label": "FAQs",
35-
"items": [
36-
"keploy-explained/keploy-security",
37-
"keploy-explained/keploy-privacy",
38-
"keploy-explained/ai-models",
39-
"keploy-explained/api-testing-faq"
40-
]
35+
"id": "keploy-explained/api-testing-faq"
4136
}
4237
]
4338
},
@@ -182,9 +177,13 @@
182177
"keploy-cloud/keploy-console",
183178
"keploy-cloud/auto-test-generation",
184179
"keploy-cloud/deduplication",
185-
"keploy-explained/common-errors",
186-
"keploy-explained/integration-testing-faq"
180+
"keploy-explained/common-errors"
187181
]
182+
},
183+
{
184+
"type": "doc",
185+
"label": "FAQs",
186+
"id": "keploy-explained/integration-testing-faq"
188187
}
189188
]
190189
},
@@ -204,15 +203,9 @@
204203
]
205204
},
206205
{
207-
"type": "category",
206+
"type": "doc",
208207
"label": "FAQs",
209-
"items": [
210-
"keploy-explained/keploy-security",
211-
"keploy-explained/keploy-privacy",
212-
"keploy-explained/ai-models",
213-
"keploy-explained/supported-languages",
214-
"keploy-explained/unit-testing-faq"
215-
]
208+
"id": "keploy-explained/unit-testing-faq"
216209
}
217210
]
218211
}

0 commit comments

Comments
 (0)