Repository navigation
ci(docs): rebuild API reference after den-api deploys - #6464
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
GitHub Actions
Error
OpenWork evidence
Run details · Open the preview to inspect evidence and sandbox options. |
![diff-warden[bot]](https://avatars.githubusercontent.com/u/118544361?s=60&v=4){kind=small}
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
Warden: approvedNo high or medium security findings and no confidentiality findings. Reviewed |
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>
8aaa265 to
3ebd1dd
Compare
Latest Warden review is not clear (analysis-cancelled); see the Warden comment.
There was a problem hiding this comment.
Warden clearance. Complete security and confidentiality review of 3ebd1ddaca7b7aed0b0d4b8c1a17a0fed9f4ada0 found no high or medium security findings and no confidentiality findings. Any new push dismisses this approval. Analysis run
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.