Repository navigation
ci(docs): rebuild API reference after den-api deploys - #6464
Open
reachjalil wants to merge 1 commit into
Open
reachjalil wants to merge 1 commit into
reachjalil wants to merge 1 commit into
Conversation
The hosted docs build the API tab from the live public contract, but the docs Git integration only rebuilds when packages/docs changes. Wait until production den-api serves the pushed commit (or a newer one), then ask Mintlify to rebuild. Missing settings or a failed rebuild only warn. Signed-off-by: Jalil <reachjalil@gmail.com>
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
reachjalil
had a problem deploying
to
pr-internal-specs
October 24, 2026 01:21 — with 
GitHub Actions
Error
GitHub Actions
Error
Contributor
![diff-warden[bot]](https://avatars.githubusercontent.com/u/118544361?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Warden clearance. Complete security and confidentiality review of 8aaa265d2dba9eaaaa29b925a0e91f9e573b3fec found no high or medium security findings and no confidentiality findings. Any new push dismisses this approval. Analysis run
Contributor
Warden: approvedNo high or medium security findings and no confidentiality findings. Reviewed |
This branch was successfully deployed
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
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.
What is this about?
The API tab in the hosted docs now rebuilds by itself once production den-api serves a change to the API contract.
What problem does it solve?
New or changed endpoints could be missing from the API reference for hours after they shipped.
What was the situation before?
The docs read the API reference from the live public contract, but Mintlify only rebuilds when something under
packages/docschanges. An API-only change reached the docs on the next unrelated docs edit. A change touching both was built before den-api deployed, so it picked up the previous contract.How is this implemented?
.github/workflows/refresh-api-docs.ymlruns ondevpushes to the paths the contract check already treats as contract sources./openapi.json?public=1untilinfo.versionis the pushed commit or a newer one (compared through the GitHub API), three reads in a row so old instances drain.MINTLIFY_API_KEYsecret orMINTLIFY_PROJECT_IDvariable, a deploy that never appears, or a failed rebuild only warns.What else changed?
ee/apps/den-api/README.mdpointing at the workflow.Release note
none
Evidence
actionlintis clean. Running the wait step locally against production confirmed an already-deployed commit and warned, without failing, for a commit that is not ondev. The Mintlify call runs only once the secret and variable are set.