apiome registry
Global options such as --base-url, --tenant and --json go before the command — see CLI reference. Exit codes are listed in Exit codes.
apiome registry
Schema registry: subjects, versions, registration, compatibility and settings.
apiome registry [OPTIONS] COMMAND [ARGS]...
Subcommands: compat, config, register, subjects, versions.
apiome registry compat
Test a schema against a subject without registering it (Confluent POST /compatibility/…).
Exits 0 when compatible and 1 when not. Until compatibility rules ship, a subject whose level is not NONE is refused with error code 42290 (exit 2).
apiome registry compat [OPTIONS] SUBJECT FILE
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
SUBJECT | text | yes | Subject name, e.g. orders-value. |
FILE | path | yes | Candidate schema file (.avsc, .json or .proto). |
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--type | text | Schema type: AVRO, JSON or PROTOBUF (default: from the extension — .avsc, .json, .proto). | ||
--version | text | Test against one version (a number or latest); default: the level's versions. | ||
--format | text | table | Output: table (default) or json (the API response). |
apiome registry config
Read or change registry settings (GET / PUT …/config, or …/subjects/{subject}).
With no option it prints the current settings; with --level, --mode or --strategy it changes them. Changing a subject that does not exist yet creates it.
apiome registry config [OPTIONS] [SUBJECT]
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
SUBJECT | text | Subject name; omit to read or change the workspace defaults. |
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--level | text | Compatibility level: NONE, BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL or FULL_TRANSITIVE. | ||
--mode | text | READWRITE or READONLY. | ||
--strategy | text | A subject's naming strategy: topic, record or topic_record. | ||
--format | text | table | Output: table (default) or json (the API response). |
apiome registry register
Register a schema under a subject (POST …/subjects/{subject}/versions).
Registering a schema the subject already holds returns its version and id unchanged.
apiome registry register [OPTIONS] SUBJECT FILE
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
SUBJECT | text | yes | Subject name, e.g. orders-value. |
FILE | path | yes | Schema file (.avsc, .json or .proto). |
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--type | text | Schema type: AVRO, JSON or PROTOBUF (default: from the extension — .avsc, .json, .proto). | ||
--strategy | text | Naming strategy for a new subject: topic, record or topic_record. | ||
--format | text | table | Output: table (default) or json (the API response). |
apiome registry subjects
List the workspace's live schema subjects (GET …/schema-registry/subjects).
apiome registry subjects [OPTIONS]
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--format | text | table | Output: table (default) or json (the API response). |
apiome registry versions
List a subject's versions, oldest first, or print one with --version (GET …/versions).
apiome registry versions [OPTIONS] SUBJECT
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
SUBJECT | text | yes | Subject name, e.g. orders-value. |
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--version | text | Print one version with its schema text: a number or latest. | ||
--format | text | table | Output: table (default) or json (the API response). |