Skip to main content
← Back to list
01Issue
FeatureShippedSwamp CLI
Assigneesstack72

#417 Docs: document VaultAnnotationProvider interface and extension opt-in pattern

Opened by stack72 · 5/22/2026· Shipped 5/23/2026

Problem

PR #1434 (swamp-club#412) added first-class vault annotation support to swamp with new CLI commands (swamp vault annotate, swamp vault inspect) and a new VaultAnnotationProvider interface for extension vault providers. The user-facing documentation in swamp-club does not yet cover this.

Proposed solution

Update the vault reference documentation at content/manual/reference/vaults.md to document:

  1. The VaultAnnotationProvider interface — its four methods (getAnnotation, putAnnotation, deleteAnnotation, listAnnotations) and the VaultAnnotation value object shape (url, notes, labels, updatedAt)
  2. The CLI commandsswamp vault annotate <vault> <key> --url --note --label --clear and swamp vault inspect <vault> <key>, including merge semantics (only specified fields are updated, existing fields preserved)
  3. Extension opt-in pattern — how extension vault authors implement annotation support by returning a provider that implements both VaultProvider and VaultAnnotationProvider via duck typing, with no schema or adapter changes needed

The how-to guide at content/manual/how-to/extensions.md may also need a section or example showing how a custom vault extension opts into annotation support.

Alternatives considered

None — documentation must reflect the new functionality.

02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED+ 1 MOREASSIGNED+ 4 MOREREVIEW+ 3 MOREPR_MERGED+ 1 MORENOTIFICATION_SKIPPED

Shipped

5/23/2026, 2:15:06 AM

Click a lifecycle step above to view its details.

03Sludge Pulse
stack72 assigned stack725/22/2026, 11:50:52 PM

Sign in to post a ripple.