Skip to content

Commit 0d4e717

Browse files
committed
docs: explain contexts and cluster coordination in known differences
Expand the terse "Contexts are single-tenant" bullet in the README with a full explanation of what Confluent contexts are (multi-tenancy namespaces for Schema Linking) and why we return only the default context. Also clarify the cluster coordination difference. Update the OpenAPI spec /contexts endpoint description and regenerate API docs.
1 parent 0ebb75e commit 0d4e717

File tree

4 files changed

+28
-9
lines changed

4 files changed

+28
-9
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,8 @@ AxonOps Schema Registry implements the Confluent Schema Registry REST API v1:
206206

207207
**Known differences:**
208208

209-
- Contexts are single-tenant only and always return `["."]`
210-
- Cluster coordination uses database constraints instead of Kafka
209+
- **Contexts** -- In Confluent Schema Registry, contexts are a multi-tenancy feature that allows multiple schemas with the same subject names and IDs to coexist in separate namespaces (e.g. `".team-a"`, `".team-b"`). Subjects are qualified with a context prefix (e.g. `:.mycontext:my-subject`), and schema IDs are unique within each context. This is primarily used for Schema Linking and enterprise multi-tenant deployments. AxonOps Schema Registry operates as a single-tenant registry -- the `GET /contexts` endpoint always returns `["."]` (the default context only), and context-qualified subject names are not supported.
210+
- **Cluster coordination** -- Confluent uses Kafka's group protocol for leader election between registry instances. AxonOps instances are fully stateless with no leader election -- database-level constraints (transactions, LWTs) handle coordination instead.
211211

212212
---
213213

api/openapi.yaml

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1634,9 +1634,20 @@ paths:
16341634
get:
16351635
summary: Get schema registry contexts
16361636
description: >-
1637-
Returns the list of contexts defined in the registry. Contexts are namespace
1638-
prefixes extracted from subject names. The default context is `.` (a single dot).
1639-
This endpoint always includes the default context in the response.
1637+
Returns the list of contexts defined in the registry.
1638+
1639+
1640+
In Confluent Schema Registry, **contexts** are a multi-tenancy feature that
1641+
allows multiple schemas with the same subject names and IDs to coexist in
1642+
separate namespaces (e.g. `.team-a`, `.team-b`). Subjects are qualified with
1643+
a context prefix (e.g. `:.mycontext:my-subject`), and schema IDs are unique
1644+
within each context. This is primarily used for Schema Linking and enterprise
1645+
multi-tenant deployments.
1646+
1647+
1648+
AxonOps Schema Registry operates as a single-tenant registry. This endpoint
1649+
always returns `["."]` (the default context only). Context-qualified subject
1650+
names are not supported.
16401651
operationId: getContexts
16411652
tags:
16421653
- Metadata

docs/api-reference.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3740,7 +3740,11 @@ curl -X GET http://localhost:8081/contexts \
37403740

37413741
`GET /contexts`
37423742

3743-
Returns the list of contexts defined in the registry. Contexts are namespace prefixes extracted from subject names. The default context is `.` (a single dot). This endpoint always includes the default context in the response.
3743+
Returns the list of contexts defined in the registry.
3744+
3745+
In Confluent Schema Registry, **contexts** are a multi-tenancy feature that allows multiple schemas with the same subject names and IDs to coexist in separate namespaces (e.g. `.team-a`, `.team-b`). Subjects are qualified with a context prefix (e.g. `:.mycontext:my-subject`), and schema IDs are unique within each context. This is primarily used for Schema Linking and enterprise multi-tenant deployments.
3746+
3747+
AxonOps Schema Registry operates as a single-tenant registry. This endpoint always returns `["."]` (the default context only). Context-qualified subject names are not supported.
37443748

37453749
> Example responses
37463750

docs/api/index.html

Lines changed: 7 additions & 3 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)