-
Notifications
You must be signed in to change notification settings - Fork 128
docs: add Javadoc to secrets package interfaces #547
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
The
secretspackage implements the Secrets Vault (envelope encryption for API keys, tokens, and other sensitive configuration). Its 3 public interfaces lack Javadoc.Interfaces to document (3)
src/main/java/ai/labs/eddi/secrets/ISecretProvider.javasrc/main/java/ai/labs/eddi/secrets/persistence/ISecretPersistence.javasrc/main/java/ai/labs/eddi/secrets/rest/IRestSecretStore.javaHow to write good Javadoc
Good example (see
IConversationMemoryStore):Bad example (don't do this):
/** Store for agents. */Acceptance criteria
@authortags are removed./mvnw compilepasses