docs: add missing OpenAPI annotations

[ded-furby]

Summary

Added the missing OpenAPI annotations from issue #551.

• Added @operation summaries/descriptions to all 3 methods in IRestUserConversationStore.
• Added @operation summaries/descriptions to both methods in IRestHtmlChatResource.
• Added class-level @tag("Authentication") to ILogoutEndpoint.
• Added matching Authentication tag metadata in OpenApiConfig.

Type of Change

• Documentation update

Related Issue

Closes #551

Changes Made

• Updated API interface annotations to improve generated docs coverage.
• Kept changes focused to documentation metadata only.

How to Test

• Ran ./mvnw compile on ded-furby/EDDI.

Checklist

• My code follows the project's code style.
• I have updated documentation.
• Existing tests pass locally (./mvnw compile).
• My commit messages follow Conventional Commits.
• I have not committed any secrets, API keys, or tokens.
• This PR has a clear, focused scope (one concern per PR).

Summary by CodeRabbit

• Documentation
  • Organized authentication-related endpoints under a new Authentication category in API documentation
  • Added detailed operation summaries and descriptions to conversation management and chat interface endpoints
  • Improved overall API documentation structure for enhanced discoverability and clarity

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cf406513-7cf6-4e1c-a276-9cba6b754208

📥 Commits

Reviewing files that changed from the base of the PR and between bd1b859 and b6d8d87.

📒 Files selected for processing (4)

• src/main/java/ai/labs/eddi/configs/OpenApiConfig.java
• src/main/java/ai/labs/eddi/engine/api/ILogoutEndpoint.java
• src/main/java/ai/labs/eddi/engine/triggermanagement/IRestUserConversationStore.java
• src/main/java/ai/labs/eddi/ui/IRestHtmlChatResource.java

---

📝 Walkthrough

Walkthrough

Adds missing OpenAPI annotations to three REST interfaces: registers an Authentication tag in OpenApiConfig, applies @Tag(name = "Authentication") to ILogoutEndpoint, and adds @Operation annotations with summaries and descriptions to all three methods of IRestUserConversationStore and both methods of IRestHtmlChatResource.

Changes

OpenAPI Annotation Additions

Layer / File(s)	Summary
Authentication tag registration and ILogoutEndpoint tagging src/main/java/ai/labs/eddi/configs/OpenApiConfig.java, src/main/java/ai/labs/eddi/engine/api/ILogoutEndpoint.java	Adds an Authentication tag entry to the global @OpenAPIDefinition tags array in OpenApiConfig, then imports Tag and applies @Tag(name = "Authentication") at the interface level on ILogoutEndpoint.
@Operation annotations on conversation store and chat UI src/main/java/ai/labs/eddi/engine/triggermanagement/IRestUserConversationStore.java, src/main/java/ai/labs/eddi/ui/IRestHtmlChatResource.java	Imports Operation and adds @Operation(summary, description) annotations to the readUserConversation, createUserConversation, and deleteUserConversation methods of IRestUserConversationStore, and to the viewDefault() and viewHtml(...) methods of IRestHtmlChatResource.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 Hop hop, the Swagger tags were bare,
No @Operation docs to share!
Authentication found its name,
Three interfaces joined the game.
Now the OpenAPI shines bright —
Every endpoint labeled right! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title accurately describes the main change: adding missing OpenAPI annotations across three REST interfaces.
Linked Issues check	✅ Passed	All objectives from issue #551 are met: @Operation annotations added to all 5 methods across two interfaces, @Tag added to ILogoutEndpoint, and tag entry added to OpenApiConfig.java.
Out of Scope Changes check	✅ Passed	All changes are directly scoped to the linked issue requirements; no out-of-scope modifications detected beyond documentation annotations.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

This PR improves generated OpenAPI/Swagger documentation coverage by adding missing MicroProfile OpenAPI annotations (@Operation, @Tag) to a few REST interfaces and registering a matching tag in the global OpenAPI definition.

Changes:

• Added @Operation summaries/descriptions to UI and conversation-store REST interfaces.
• Added class-level @Tag(name = "Authentication") to the logout/authentication REST interface.
• Registered the new Authentication tag in OpenApiConfig so Swagger UI shows it with the intended metadata/order.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
src/main/java/ai/labs/eddi/ui/IRestHtmlChatResource.java	Adds @Operation metadata for the embedded chat UI endpoints.
src/main/java/ai/labs/eddi/engine/triggermanagement/IRestUserConversationStore.java	Adds @Operation metadata for read/create/delete user conversation endpoints.
src/main/java/ai/labs/eddi/engine/api/ILogoutEndpoint.java	Adds an Authentication tag to group auth endpoints in OpenAPI.
src/main/java/ai/labs/eddi/configs/OpenApiConfig.java	Registers the Authentication tag in the canonical tag taxonomy.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.