docs: clarify API product model descriptions#1810
Conversation
Memtensor-AI
left a comment
There was a problem hiding this comment.
LGTM
Clean documentation-only change. The descriptions are clearer, the TODO is resolved, and the filter examples now use valid syntax instead of the ambiguous "`and` or `or`" key. No logic, defaults, or validation affected.
One minor suggestion:
- The multi-line
descriptionstrings inside triple-quotedField(...)blocks (lines ~114, ~407, ~833) will include leading whitespace in the generated OpenAPI schema. Consider usingtextwrap.dedentor parenthesized string concatenation (as you already do forsearch_memory_typeandsource) for consistent rendering in Swagger/Redoc. Not a blocker — just a cosmetic inconsistency across the same file.
Ship it.
|
Thanks for the review. I pushed Validation:
Security/behavior note: this remains documentation/schema metadata only; no request validation, defaults, auth, persistence, networking, or secret-handling behavior changed. |
|
Automated Test Results: PASSED Cloud test-engine rerun against
Manual code review is still required before merge. |
Fixes #1699
Summary
APISearchRequest.filter.search_memory_typeand pluginsourcedescriptions without changing fields, defaults, or validation.Root Cause
The generated API documentation was exposing placeholder/vague schema descriptions, including an unresolved TODO and ambiguous filter examples.
Validation
python -m py_compile src/memos/api/product_models.pygit diff --checkrg 'TODO: maybe add detailed description later|router diff search|andoror|Filter for the memory' src/memos/api/product_models.py-> no matchesSecurity
Documentation/schema metadata only. No auth, permission checks, persistence, retrieval logic, network behavior, or secret handling changed.