docs: clarify API product model descriptions#1810
Open
Lucas-FManager wants to merge 2 commits into
Open
Conversation
Collaborator
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.
Author
|
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. |
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.
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.