Use the deployed OpenAPI spec for API reference - #496
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
sjmiller609
marked this pull request as ready for review
August 10, 2026 17:43
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Risk assessment: Low
What changed (from the diff)
docs.json: API Reference OpenAPI source updated from the Stainless hosted documented YAML tohttps://api.onkernel.com/spec.jsonspecs/openapi.documented.yml: deleted (large generated/checked-in artifact no longer referenced)
Why this is Low risk
- Scope is limited to Mintlify docs configuration and removal of an unused local OpenAPI file
- No application runtime, auth, billing, permissions, or infrastructure code paths are modified
- Blast radius is the public API Reference docs tab content/source only; correctness is easy to reason about
- Independent checks: production
spec.jsonis reachable and parses as OpenAPI 3.1 with a comparable path surface to the removed YAML; Mintlify Deployment already succeeded on this PR
Residual notes (non-blocking)
- Docs rendering now depends on availability/correctness of the production OpenAPI endpoint
- API Reference content may drift if the production spec differs from the former Stainless "documented" view
Decision: Low risk — approving. No CODEOWNERS file found; PR had no prior approvals from this automation.
Sent by Cursor Automation: Assign PR reviewers
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
https://api.onkernel.com/spec.jsonWhy
The docs can read the production API's OpenAPI document directly. This removes the hosted Stainless dependency and avoids maintaining a second generated copy of the same API surface.
Companion change
kernel/kernel#3253 removes the workflow and generation target that maintained the checked-in spec.
Testing
docs.jsonwithjqNote
Low Risk
Single Mintlify config URL change for documentation only; no runtime or API behavior changes.
Overview
The API Reference tab in
docs.jsonnow pulls OpenAPI from the production endpointhttps://api.onkernel.com/spec.jsoninstead ofhttps://app.stainless.com/api/spec/documented/kernel/openapi.documented.yml.Docs stay aligned with the live API surface without a hosted Stainless spec or a second generated copy in this repo (maintenance removed in the companion kernel PR).
Reviewed by Cursor Bugbot for commit aa9cfb6. Bugbot is set up for automated code reviews on this repo. Configure here.