Skip to content

docs: add @APIResponse annotations to IRestUserMemoryStore #548

Open

Description

@ginccc

Summary

IRestUserMemoryStore has 9 REST methods with @Operation but zero @APIResponse annotations. This is the largest single gap in OpenAPI coverage.

File

src/main/java/ai/labs/eddi/configs/properties/IRestUserMemoryStore.java

Pattern to follow

See IRestAgentStore.java for the established pattern. Common status codes:

  • GET: 200, 404
  • POST/PUT: 200 or 201, 400
  • DELETE: 204, 404

Check the implementation (RestUserMemoryStore.java) to verify which status codes each method actually returns.

Acceptance criteria

  • All 9 methods have appropriate @APIResponse annotations
  • ./mvnw compile passes

Activity

  1. added
    documentationJavadoc, markdown docs, OpenAPI annotations, code comments
    good first issueClear scope, low risk, pattern to follow - ideal for newcomers
    size: SSmall: about 1 hour, 2-8 files, mechanical pattern-following
    on Jun 18, 2026
  2. nightcityblade commented on Jun 19, 2026

    @nightcityblade

    Hi, I'd like to work on this. I'll submit a PR shortly.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationJavadoc, markdown docs, OpenAPI annotations, code commentsgood first issueClear scope, low risk, pattern to follow - ideal for newcomershelp wantedsize: SSmall: about 1 hour, 2-8 files, mechanical pattern-following

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions