Skip to content

Commit 0ebb75e

Browse files
committed
docs: remove version from API reference title, add OpenAPI to README
Strip v1.0.0 from the auto-generated api-reference.md title via the generation script. Fix TOC generation by exporting the TOC env var. Add built-in API documentation (OpenAPI/Swagger UI/ReDoc) to the README "Why" section.
1 parent b973461 commit 0ebb75e

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Unlike Confluent Schema Registry, which uses Kafka itself (a special `_schemas`
5151
- **Enterprise Security** -- LDAP, OIDC, mTLS, API keys, JWT, and RBAC out of the box
5252
- **Cloud Native** -- designed for Kubernetes with health checks, Prometheus metrics, and graceful shutdown
5353
- **Multi-Datacenter** -- active-active deployments with Cassandra's native cross-DC replication
54+
- **Built-in API Documentation** -- OpenAPI spec with Swagger UI and ReDoc, always in sync with the codebase
5455

5556
## Feature Comparison
5657

docs/api-reference.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
<!-- Do not edit manually. Regenerate with: make docs-api -->
33

44

5-
# AxonOps Schema Registry v1.0.0
6-
5+
# AxonOps Schema Registry
76
AxonOps Schema Registry is a drop-in replacement for the Confluent Schema Registry,
87
providing full API compatibility with extensions for enterprise security and
98
multi-backend storage. It supports **Avro**, **Protobuf**, and **JSON Schema**
@@ -12,7 +11,7 @@ formats for schema management.
1211

1312
## Contents
1413

15-
- [AxonOps Schema Registry v1.0.0](#axonops-schema-registry-v100)
14+
- [AxonOps Schema Registry](#axonops-schema-registry)
1615
- [Key Concepts](#key-concepts)
1716
- [Content Types](#content-types)
1817
- [Error Handling](#error-handling)

scripts/generate-api-docs.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ perl -0777 -pe '
8282
# Remove stray HTML break tags
8383
s|<br\s*/?>||g;
8484
85+
# Strip version suffix from the title heading (e.g. "v1.0.0")
86+
s/^(# .+?) v\d+\.\d+\.\d+\s*$/$1/gm;
87+
8588
# Collapse runs of 3+ blank lines to 2
8689
s/\n{4,}/\n\n\n/g;
8790
' "$TMPFILE" > "$TMPFILE2"
@@ -113,6 +116,7 @@ generate_toc() {
113116
}
114117

115118
TOC="$(generate_toc "$TMPFILE2")"
119+
export TOC
116120

117121
# ── Assemble final output ─────────────────────────────────────────────
118122
#

0 commit comments

Comments
 (0)