docs: fix drift in Admin Operations#166
Merged
Merged
Conversation
POST /enrichment/reprocess response schema had two inaccuracies: - `count` description said "successfully added" implying per-job tracking; the endpoint returns len(ids) from the request regardless (enqueue_enrichment is called for each ID with no per-item error capture) - `ids` field docs implied input ordering; actual response uses sorted(ids) — lexicographic order Verified against: automem@ed36b98e3e1569dde71aa430417b6549520f7068 (automem/api/enrichment.py)
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Admin API documentation to match the current behavior of POST /enrichment/reprocess, clarifying what the response fields actually represent.
Changes:
- Clarifies that
countreflects how many UUIDs were submitted in the request (not a success/failure metric). - Clarifies that
idsare returned sorted lexicographically.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | `status` | string | Always `"queued"` | | ||
| | `count` | integer | Number of memories successfully added to enrichment queue | | ||
| | `ids` | array[string] | List of memory UUIDs that were queued | | ||
| | `count` | integer | Number of UUIDs submitted (equals `len(ids)` from the request; not a success/failure count) | |
Per Copilot review: removed Python-specific len(ids) reference from the count field description; rephrased to describe the request payload instead.
Deploying automem-website with
|
| Latest commit: |
76322a2
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b193bc65.automem-website.pages.dev |
| Branch Preview URL: | https://docs-audit-admin-operations.automem-website.pages.dev |
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.
Claim → current state → fix
count: "Number of memories successfully added to enrichment queue"automem/api/enrichment.pyreturns"count": len(ids)whereidsis the raw request list;enqueue_enrichment()is called for every ID with no per-item error capture, so count always equals the number of IDs submitted, not a filtered success countlen(ids)from the request; not a success/failure count)"idsexample implied insertion ordersorted(ids)— lexicographic sortNot changed: The
POST /admin/syncsection has no response schema documented. This appears to be intentionally thin docs for a newer endpoint rather than drift — left as-is and flagged as a follow-up for the maintainer.Verified against: automem@ed36b98e3e1569dde71aa430417b6549520f7068 (
automem/api/enrichment.py)Generated by Claude Code