Repository navigation
docs(query): explain pending source updates for agents - #328
adityashrivastavaa wants to merge 1 commit into
Conversation
✅ Mintlify HygieneNo issues found. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
✅ OpenHack SummarySecurity review of docs(query): explain pending source updates for agents. 4 changed files; 0 findings at or above the low reporting threshold. Confidence Score: 5/5No reportable security findings were detected in this scan. Security merge-readiness rubric: 1 = critical, 2 = high, 3 = medium, 4 = low, 5 = no reportable findings. This score reflects scan findings, not a guarantee of correctness or complete coverage. Files Needing Attention: None Important Files Changed
Last reviewed commit: e1ff721 · View review on OpenHack
|
Signed-off-by: adityashrivastavaa <288670127+adityashrivastavaa@users.noreply.github.com> Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
f876bd1 to
e1ff721
Compare
Description
Add a Pending Updates guide under v2 Retrieve and cross-link Query and How to Use API Results. Explain the optional
pending_updatesblock, indexed Olympus facts versus newer ticket evidence, response formats, safe agent attribution, permissions, and best-effort coverage.This is a pending-rollout contract, not a general-availability announcement or an instant-sync guarantee. Keep this PR draft until the upstream feature is merged, deployment support is confirmed, and release/maintainer review approves publication. Generated OpenAPI remains owned by the application publication pipeline; no API specs or archive files are changed.
Validation: Node 24.11.0 and pnpm 9 frozen install;
make build PKG_RUN='npx --yes pnpm@9'passed; hygiene returned zero findings; 38 local MDX links and four JSON examples passed checks. Local Mintlify browser preview confirmed the new guide, Retrieve navigation, and both cross-link notes.Related Issue
Closes #327
Prepared and opened at the user's explicit request. GitHub maintainer acknowledgment of the issue and publication approval have not been recorded and are not claimed.
Type of Change
Checklist
git commit -s) per the DCOmintlify devrenders my changes correctlyNeed help on this PR? Tag
@codesmith-botwith what you need.