Skip to content

docs(api): document raw query param on /content/read (#2225)#2278

Merged
qin-ctx merged 2 commits into
volcengine:mainfrom
r266-tech:docs-content-read-raw-2225
May 28, 2026
Merged

docs(api): document raw query param on /content/read (#2225)#2278
qin-ctx merged 2 commits into
volcengine:mainfrom
r266-tech:docs-content-read-raw-2225

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Summary

Document the new raw query parameter on GET /api/v1/content/read, added by #2225 (qin-ctx → ZaynJarvis, merged 2026-05-25). The API reference table in docs/{en,zh}/api/03-filesystem.md still lists only uri/offset/limit; users hitting the REST endpoint have no way to discover raw=true from the docs.

Source

openviking/server/routers/content.py:66:

raw: bool = Query(False, description="Return raw stored content without memory-field cleanup"),

The handler then gates MEMORY_FIELDS cleanup behind if not raw:. The flag is HTTP-only — the Python SDK (openviking_cli/client/sync_http.py:read) does not yet pass it through.

Changes

  • docs/en/api/03-filesystem.md: +1 row in the read() Parameters table.
  • docs/zh/api/03-filesystem.md: +1 row, mirrored.

2 LOC total, additive, byte-grounded against the FastAPI Query description.

Notes

  • Pure docs; no behavior change.
  • Single author r266-tech (no co-author trailer).

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

2225 - Fully compliant

Compliant requirements:

  • Added raw parameter row to English API docs
  • Added raw parameter row to Chinese API docs
⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🏅 Score: 100
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ No major issues detected

@github-actions
Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

@qin-ctx qin-ctx merged commit cfe3d8b into volcengine:main May 28, 2026
3 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project May 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants