-
Notifications
You must be signed in to change notification settings - Fork 128
docs: add missing @Operation and @Tag to 3 REST interfaces #551
Copy link
Copy link
Open
Labels
documentationJavadoc, markdown docs, OpenAPI annotations, code commentsJavadoc, markdown docs, OpenAPI annotations, code commentsgood first issueClear scope, low risk, pattern to follow - ideal for newcomersClear scope, low risk, pattern to follow - ideal for newcomershelp wantedsize: XSTrivial: under 30 min, 1-3 lines, single fileTrivial: under 30 min, 1-3 lines, single file
Description
Activity
Metadata
Metadata
Assignees
Labels
documentationJavadoc, markdown docs, OpenAPI annotations, code commentsJavadoc, markdown docs, OpenAPI annotations, code commentsgood first issueClear scope, low risk, pattern to follow - ideal for newcomersClear scope, low risk, pattern to follow - ideal for newcomershelp wantedsize: XSTrivial: under 30 min, 1-3 lines, single fileTrivial: under 30 min, 1-3 lines, single file
Summary
Three REST interfaces are missing core OpenAPI annotations that all other REST endpoints have.
What to add
IRestUserConversationStoreengine/triggermanagement/IRestUserConversationStore.java@Operationon all 3 methodsIRestHtmlChatResourceui/IRestHtmlChatResource.java@Operationon both methodsILogoutEndpointengine/api/ILogoutEndpoint.java@Tagclass-level annotation (methods already have@Operation)Pattern
@Operation— add asummaryfield:@Tag:Tags should match an entry in
src/main/java/ai/labs/eddi/configs/OpenApiConfig.java. If no matching tag exists, add one there too.Acceptance criteria
IRestUserConversationStore: all 3 methods have@OperationIRestHtmlChatResource: both methods have@OperationILogoutEndpoint: has class-level@Tag./mvnw compilepasses