Skip to content

Commit 02015d5

Browse files
kbatuigasclaude
andcommitted
Fix style issues from docs review
- Fix version phrasing in overlay: "v26.1 and later" -> "version 26.1 or later" - Fix comma splice in schema_metadata_request description - Add missing description to defaultToGlobal on GET /config/{subject} - Clarify "subject-version" -> "subject-version pairs" in summary - Make POST /security/acls description add value beyond the summary Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 98ab72f commit 02015d5

2 files changed

Lines changed: 5 additions & 4 deletions

File tree

schema-registry/overlays/add-external-docs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ actions:
1616
- [Use Redpanda Cloud with the Schema Registry API](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-api/)
1717
- [Use Redpanda Self-Managed with the Schema Registry API](https://docs.redpanda.com/current/manage/schema-reg/schema-reg-api/)
1818
19-
Schema Registry contexts (available in Redpanda v26.1 and later) provide an isolated namespace for schemas, subjects, and configuration. Any endpoint path can be prefixed with `/contexts/{context}/` to scope operations to a specific context, and you can also use a context-qualified subject anywhere the API accepts a subject. See the [Redpanda Cloud](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-contexts/) (configurable only in BYOC and Dedicated clusters) or [Redpanda Self-Managed](https://docs.redpanda.com/current/manage/schema-reg/schema-reg-contexts/) documentation for details.
19+
Schema Registry contexts (available in Redpanda version 26.1 or later) provide an isolated namespace for schemas, subjects, and configuration. Any endpoint path can be prefixed with `/contexts/{context}/` to scope operations to a specific context, and you can also use a context-qualified subject anywhere the API accepts a subject. See the [Redpanda Cloud](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-contexts/) (configurable only in BYOC and Dedicated clusters) or [Redpanda Self-Managed](https://docs.redpanda.com/current/manage/schema-reg/schema-reg-contexts/) documentation for details.

schema-registry/schema-registry.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
},
2525
{
2626
"name": "defaultToGlobal",
27+
"description": "If true, return the global compatibility level if the subject doesn't have a level set.",
2728
"in": "query",
2829
"required": false,
2930
"type": "boolean"
@@ -570,7 +571,7 @@
570571
},
571572
"/schemas/ids/{id}/versions": {
572573
"get": {
573-
"summary": "Get a list of subject-version for the schema ID.",
574+
"summary": "Get a list of subject-version pairs for the schema ID.",
574575
"operationId": "get_schemas_ids_id_versions",
575576
"parameters": [
576577
{
@@ -1545,7 +1546,7 @@
15451546
},
15461547
"post": {
15471548
"summary": "Create ACLs",
1548-
"description": "Create new ACL rules.",
1549+
"description": "Create one or more ACL rules. The request body is an array of ACL definitions.",
15491550
"operationId": "post_security_acls",
15501551
"parameters": [
15511552
{
@@ -1689,7 +1690,7 @@
16891690
"properties": {
16901691
"properties": {
16911692
"type": "object",
1692-
"description": "Accepted values may be string, number, or boolean, they are converted to strings.",
1693+
"description": "Accepted values may be string, number, or boolean. All values are converted to strings.",
16931694
"additionalProperties": {
16941695
"type": "string"
16951696
}

0 commit comments

Comments
 (0)