Skip to content

docs: add missing @Operation and @Tag to 3 REST interfaces #551

Description

@ginccc

Summary

Three REST interfaces are missing core OpenAPI annotations that all other REST endpoints have.

What to add

Interface File What's missing
IRestUserConversationStore engine/triggermanagement/IRestUserConversationStore.java @Operation on all 3 methods
IRestHtmlChatResource ui/IRestHtmlChatResource.java @Operation on both methods
ILogoutEndpoint engine/api/ILogoutEndpoint.java @Tag class-level annotation (methods already have @Operation)

Pattern

@Operation — add a summary field:

@Operation(summary = "Read user conversation", description = "...")

@Tag:

@Tag(name = "Authentication")

Tags should match an entry in src/main/java/ai/labs/eddi/configs/OpenApiConfig.java. If no matching tag exists, add one there too.

Verify before starting: Confirm these annotations are still missing — the codebase may have been updated since this issue was filed.

Acceptance criteria

  • IRestUserConversationStore: all 3 methods have @Operation
  • IRestHtmlChatResource: both methods have @Operation
  • ILogoutEndpoint: has class-level @Tag
  • ./mvnw compile passes

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: XSTrivial: under 30 min, 1-3 lines, single file

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions