OpenParable
Skip to content
← Back to skills

Storage Variant Guide

Development
storage-variant-guide

Storage Variant Guide is an Agent Skill for development published in the Apicurio/apicurio-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Guide for implementing features across all storage variants. Use when the user is adding or modifying storage layer functionality.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/Apicurio/apicurio-registry/blob/HEAD/.claude/skills/storage-variant-guide/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/storage-variant-guide, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Storage Variant Implementation Guide

When implementing a feature that touches the storage layer:

  1. Start with SQL (app/src/.../storage/impl/sql/) — this is the canonical implementation
  2. Adapt for KafkaSQL (app/src/.../storage/impl/kafkasql/) — uses a Kafka journal pattern; state changes are serialized as Kafka messages and replayed
  3. Consider GitOps (app/src/.../storage/impl/gitops/) — file-based, git-backed
  4. Consider KubernetesOps (app/src/.../storage/impl/kubernetesops/) — ConfigMap-based
  5. Update RegistryStorage interface if adding new operations
  6. Update decorators (storage/decorator/) if the feature needs cross-cutting behavior
  7. DTOs must be serializable — KafkaSQL journals serialize them
  8. Test with at least SQL and KafkaSQL integration test profiles