You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add table of contents to all documentation pages
Add consistent "## Contents" section with anchor links to all 14 docs
and README. Update generate-api-docs.sh to auto-generate and inject a
TOC into the api-reference.md output, positioned right after the title.
Copy file name to clipboardExpand all lines: README.md
+17Lines changed: 17 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,23 @@
2
2
3
3
A high-performance, API-compatible Kafka Schema Registry written in Go. Drop-in replacement for Confluent Schema Registry with enterprise features including multiple storage backends, flexible authentication, and comprehensive audit logging.
Copy file name to clipboardExpand all lines: docs/authentication.md
+61Lines changed: 61 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,67 @@
2
2
3
3
This guide covers how to configure and use authentication in AxonOps Schema Registry. Authentication controls who can access the registry API. When combined with role-based access control (RBAC), it also determines what each user can do.
Authentication is optional but recommended for production deployments. When enabled, the registry supports multiple authentication methods simultaneously. Requests are evaluated against each configured method in the order they appear in the `methods` list until one succeeds:
-[Wire-Compatible Type Groups](#wire-compatible-type-groups)
27
+
-[Cardinality Changes](#cardinality-changes)
28
+
-[Syntax Changes](#syntax-changes)
29
+
-[Service Definitions](#service-definitions)
30
+
-[Checking Compatibility via API](#checking-compatibility-via-api)
31
+
-[Check Against a Specific Version](#check-against-a-specific-version)
32
+
-[Check Against All Versions](#check-against-all-versions)
33
+
-[Request Body](#request-body)
34
+
-[Response](#response)
35
+
-[Verbose Mode](#verbose-mode)
36
+
-[Example: Check Before Registering](#example-check-before-registering)
37
+
-[Compatibility Groups](#compatibility-groups)
38
+
-[How It Works](#how-it-works)
39
+
-[Configuration](#configuration)
40
+
-[Registering Schemas with Groups](#registering-schemas-with-groups)
41
+
-[Related Documentation](#related-documentation)
42
+
3
43
## Overview
4
44
5
45
Compatibility checking ensures that new schema versions can coexist with previous versions. The registry checks compatibility at registration time -- when a new schema version is registered via `POST /subjects/{subject}/versions`. If the proposed schema is incompatible with existing versions (under the active compatibility mode), the registry rejects the registration with HTTP 409 and an error message describing the incompatibility.
-[Option 1: TLS at the Load Balancer (Recommended)](#option-1-tls-at-the-load-balancer-recommended)
31
+
-[Option 2: TLS at the Registry](#option-2-tls-at-the-registry)
32
+
-[Network Requirements](#network-requirements)
33
+
-[Related Documentation](#related-documentation)
34
+
3
35
## Overview
4
36
5
37
AxonOps Schema Registry is a stateless binary. All state -- schemas, subjects, configuration, users, and API keys -- is stored in the database. This means multiple instances can be deployed behind a load balancer with no coordination between them. There is no leader election, no peer discovery, and no inter-instance communication.
Copy file name to clipboardExpand all lines: docs/getting-started.md
+26Lines changed: 26 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,32 @@
2
2
3
3
This guide walks you through running AxonOps Schema Registry, registering your first schemas, and verifying compatibility. You should have a working registry within five minutes.
4
4
5
+
## Contents
6
+
7
+
-[Prerequisites](#prerequisites)
8
+
-[Quick Start with Docker](#quick-start-with-docker)
9
+
-[Quick Start with Binary](#quick-start-with-binary)
10
+
-[Build from Source](#build-from-source)
11
+
-[Run](#run)
12
+
-[Your First API Calls](#your-first-api-calls)
13
+
-[Check Health](#check-health)
14
+
-[Register an Avro Schema](#register-an-avro-schema)
15
+
-[Retrieve the Schema](#retrieve-the-schema)
16
+
-[List Subjects](#list-subjects)
17
+
-[Register a Second Version](#register-a-second-version)
18
+
-[Check Compatibility](#check-compatibility)
19
+
-[Register a JSON Schema](#register-a-json-schema)
20
+
-[Register a Protobuf Schema](#register-a-protobuf-schema)
0 commit comments