Skip to main content

jeap-opensearch-index-type-registry-maven-plugin

Maven plugin for managing an OpenSearch Index Type Registry — a Git repository that is the single source of truth for all OpenSearch index types in a microservice landscape.

Key Features

  • Validation: Enforces naming conventions, snake_case field names, and schema correctness on every build
  • Immutability: Existing mapping files on the trunk branch are immutable (CRC32-checked); index types and system directories cannot be deleted
  • Backward compatibility: Minor version changes may only add fields; breaking changes require a major version bump
  • Code generation: Generates typed Java records and IndexType<T> singletons from mapping definitions
  • Artifact deployment: Publishes one Maven JAR per (index type, major version) pair for consumption by service instances

Documentation