Skip to content

docs(query): explain pending source updates for agents - #328

Draft
adityashrivastavaa wants to merge 1 commit into
mainfrom
docs/pending-source-updates
Draft

adityashrivastavaa wants to merge 1 commit into
mainfrom
docs/pending-source-updates

Conversation

@adityashrivastavaa

@adityashrivastavaa adityashrivastavaa commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Description

Add a Pending Updates guide under v2 Retrieve and cross-link Query and How to Use API Results. Explain the optional pending_updates block, 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.

Pending rollout guide and Retrieve navigation

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

  • Content fix (typo, broken link, incorrect info)
  • New content (guide, tutorial, API docs)
  • Structural change (navigation, layout)
  • CI/Build

Checklist

  • I have read the CONTRIBUTING guidelines
  • This PR is linked to an issue
  • My commits are signed off (git commit -s) per the DCO
  • mintlify dev renders my changes correctly
  • I have not committed any secrets or credentials
  • No internal system details are exposed in the content

Open in Capy


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.

@github-actions

Copy link
Copy Markdown

✅ Mintlify Hygiene

No issues found.

@mintlify

mintlify Bot commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
cortex-ai 🟢 Ready View Preview Oct 22, 2026, 8:33 PM

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

@openhack-agent

openhack-agent Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

✅ OpenHack Summary

Security review of docs(query): explain pending source updates for agents. 4 changed files; 0 findings at or above the low reporting threshold.

P1: Critical 0   P2: High 0   P3: Medium 0   P4: Low 0

Confidence Score: 5/5

No 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
  • docs.json (modified)
  • essentials/v2/api-results.mdx (modified)
  • essentials/v2/pending-updates.mdx (added)
  • essentials/v2/query.mdx (modified)

Last reviewed commit: e1ff721 · View review on OpenHack


TIP: Mention @openhack-agent in a PR comment to request a review or ask a question. Use @openhack-agent fix all for every finding, or @openhack-agent fix unresolved threads for open review threads only.

@openhack-agent openhack-agent 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.

OpenHack reviewed this commit. See the OpenHack Summary for the confidence score and fix actions.

Signed-off-by: adityashrivastavaa <288670127+adityashrivastavaa@users.noreply.github.com>
Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>

This branch was successfully deployed

1 active deployment
staging — e1ff721e Deployed Oct 22, 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.

Document pending source updates in query results

1 participant