Skip to content

docs(public-api): add API docs URL alongside base URL#829

Merged
slayerjain merged 1 commit intomainfrom
docs/public-api-add-docs-url
Apr 14, 2026
Merged

docs(public-api): add API docs URL alongside base URL#829
slayerjain merged 1 commit intomainfrom
docs/public-api-add-docs-url

Conversation

@slayerjain
Copy link
Copy Markdown
Member

What has changed?

Adds a pointer to the interactive API reference (https://api.keploy.io/client/v1/docs) right below the Base URL on the Public REST API page, so readers can discover it without leaving the docs.

Updated file: versioned_docs/version-4.0.0/running-keploy/public-api.md

Type of change

  • Documentation update (if none of the other choices apply).

How Has This Been Tested?

Local docs build preview — the new line renders as a clickable link directly under the existing Base URL entry. No other content on the page is affected.

Checklist:

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

Link to https://api.keploy.io/client/v1/docs so readers can discover
the interactive API reference from the Public REST API page.

Signed-off-by: slayerjain <shubhamkjain@outlook.com>
Copilot AI review requested due to automatic review settings April 14, 2026 04:42
Copy link
Copy Markdown
Contributor

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 updates the v4.0.0 “Public REST API” documentation to surface the interactive API reference URL directly under the existing base URL so readers can discover the Swagger-style docs more easily.

Changes:

  • Add an “API Docs” link (https://api.keploy.io/client/v1/docs) immediately below the Base URL on the Public REST API page.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@slayerjain slayerjain merged commit a9796dd into main Apr 14, 2026
11 checks passed
@slayerjain slayerjain deleted the docs/public-api-add-docs-url branch April 14, 2026 04:45
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