Skip to content

Hide internal Search endpoints in API reference - #636

Merged
chruffins merged 1 commit into
mainfrom
hypeship/hide-internal-search-api-docs
Sep 25, 2026
Merged

chruffins merged 1 commit into
mainfrom
hypeship/hide-internal-search-api-docs

Conversation

@chruffins

@chruffins chruffins commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Description

Search is currently internal, so hide it in the API reference to avoid confusing anyone reading it.


Note

Low Risk
Documentation-only overlay; no runtime API or auth behavior changes.

Overview
Adds an OpenAPI overlay (search-api-overlay.yaml) that layers on https://api.onkernel.com/spec.json and strips Search routes from the published API reference: /search, /search/{id}, /search/{id}/contents, and /search/providers.

Search stays internal; the public docs no longer surface those endpoints.

Reviewed by Cursor Bugbot for commit 4d3a93c. Configure here.

@mintlify

mintlify Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
Kernel 🟢 Ready View Preview Sep 25, 2026, 7:32 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk: Very Low. Approving.

The diff adds one 14-line OpenAPI overlay, search-api-overlay.yaml. It extends https://api.onkernel.com/spec.json (the spec referenced by the API Reference tab in docs.json) and removes four paths: /search, /search/{id}, /search/{id}/contents, and /search/providers.

Mintlify applies auto-discovered overlays whose extends matches a spec when docs.json has no explicit overlay list, so this will drop those operations from the published API reference. Those four paths are present on the live spec today, so the removals target real operations.

This does not change API runtime behavior, auth, permissions, or infrastructure. Blast radius is the generated docs pages for those four routes. No CODEOWNERS file is present.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@chruffins
chruffins merged commit 4dcfa5c into main Sep 25, 2026
4 checks passed
@chruffins
chruffins deleted the hypeship/hide-internal-search-api-docs branch September 25, 2026 19:45

This branch was successfully deployed

1 active deployment
staging — 4d3a93c0 Deployed Sep 25, 2026 by mintlify[bot]
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.

1 participant