Skip to content

Improve API product model field descriptions #1699

Closed

Description

@CaralHsi

Some API product models have incomplete field descriptions. This issue is to improve those descriptions so generated API documentation is clearer.

Target file

  • src/memos/api/product_models.py

Existing TODO

# TODO: maybe add detailed description later

Requirements

  • Add clear and concise descriptions for fields that currently lack detail.
  • Keep model behavior unchanged.
  • Do not rename fields or change validation logic.
  • Follow the style of existing descriptions in the file.

Acceptance Criteria

  • The TODO is resolved.
  • API model descriptions are clearer.
  • No behavior changes are introduced.

Activity

  1. github-actions commented on Jul 5, 2026

    @github-actions
    Contributor

    This issue has been automatically marked as stale due to inactivity.

  2. added
    status:staleAuto-marked stale after 30d inactivity; closes 7d later unless exempt.
    on Jul 5, 2026
  3. added
    status:in-progressSomeone or AI is working on it | 人工或 AI 正在处理
    and removed
    types:enhancementNew feature or improvement | 新功能或改进
    status:staleAuto-marked stale after 30d inactivity; closes 7d later unless exempt.
    area:coreMOS 编排层 / 框架底座 / 跨模块问题
    on Jul 7, 2026
  4. added theissue type on Jul 7, 2026
  5. shinetata commented on Jul 9, 2026

    @shinetata
    Collaborator

    This has been addressed by PR #1810 (docs: clarify API product model descriptions), merged on Jul 8, 2026.

    All three acceptance criteria are met:

    • The # TODO: maybe add detailed description later comment has been removed.
    • Field descriptions across all API product models have been clarified and normalized.
    • No behavioral changes were introduced.

    Closing as completed. Thanks for filing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

area:docs文档、示例contrib:good-first-issueGood for newcomers | 适合新手status:in-progressSomeone or AI is working on it | 人工或 AI 正在处理

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions