From 1b0eb62b9375ce10c3ca6a07d7bd2eb4693ac613 Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Thu, 16 Apr 2026 17:21:45 -0700 Subject: [PATCH 1/5] Add contexts and sync Schema Registry API spec to source --- .../overlays/add-external-docs.yaml | 3 +- schema-registry/schema-registry.json | 406 ++++++++++++++++-- 2 files changed, 363 insertions(+), 46 deletions(-) diff --git a/schema-registry/overlays/add-external-docs.yaml b/schema-registry/overlays/add-external-docs.yaml index 145f41e..72af88c 100644 --- a/schema-registry/overlays/add-external-docs.yaml +++ b/schema-registry/overlays/add-external-docs.yaml @@ -15,4 +15,5 @@ actions: - [Use Redpanda Cloud with the Schema Registry API](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-api/) - [Use Redpanda Self-Managed with the Schema Registry API](https://docs.redpanda.com/current/manage/schema-reg/schema-reg-api/) - \ No newline at end of file + + 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. \ No newline at end of file diff --git a/schema-registry/schema-registry.json b/schema-registry/schema-registry.json index 5f8261d..92bcc99 100644 --- a/schema-registry/schema-registry.json +++ b/schema-registry/schema-registry.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Redpanda Schema Registry API", - "version": "1.1.2" + "version": "1.2.0" }, "host": "localhost:8081", "basePath": "/", @@ -17,6 +17,7 @@ "parameters": [ { "name": "subject", + "description": "The subject to get the config for. Use [:.:] for context-qualified subjects, or just for the default context. Use :.: for context-level config.", "in": "path", "required": true, "type": "string" @@ -59,6 +60,7 @@ "parameters": [ { "name": "subject", + "description": "The subject to set the config for. Use [:.:] for context-qualified subjects, or just for the default context. Use :.: for context-level config.", "in": "path", "required": true, "type": "string" @@ -97,6 +99,7 @@ "parameters": [ { "name": "subject", + "description": "The subject to delete the config for. Use [:.:] for context-qualified subjects, or just for the default context. Use :.: for context-level config.", "in": "path", "required": true, "type": "string" @@ -275,7 +278,7 @@ "parameters": [ { "name": "subject", - "description": "The subject to get the mode for.", + "description": "The subject to get the mode for. Use [:.:] for context-qualified subjects, or just for the default context. Use :.: for context-level mode.", "in": "path", "required": true, "type": "string" @@ -325,7 +328,7 @@ "parameters": [ { "name": "subject", - "description": "The subject to set the mode for.", + "description": "The subject to set the mode for. Use [:.:] for context-qualified subjects, or just for the default context. Use :.: for context-level mode.", "in": "path", "required": true, "type": "string" @@ -383,7 +386,7 @@ "parameters": [ { "name": "subject", - "description": "The subject to delete the mode for.", + "description": "The subject to delete the mode for. Use [:.:] for context-qualified subjects, or just for the default context. Use :.: for context-level mode.", "in": "path", "required": true, "type": "string" @@ -462,6 +465,20 @@ "required": false, "type": "string", "description": "Redpanda version 25.2 or later. For Avro and Protobuf schemas only. Supported values: an empty string `''` returns the schema in its current format (default), and `serialized` (Protobuf only) returns the schema in its Base64-encoded wire binary format. Unsupported values return a 501 error." + }, + { + "name": "subject", + "in": "query", + "required": false, + "type": "string", + "description": "Optional qualified subject to search for the schema under. Use <:.context:> for context-only lookup, or <:.context:subject> to also verify the schema is associated with that subject. Defaults to searching the default context if unspecified." + }, + { + "name": "referenceFormat", + "in": "query", + "required": false, + "type": "string", + "description": "If set to 'qualified', schema references are returned in context-qualified form. Otherwise, unqualified references are returned." } ], "produces": [ @@ -473,7 +490,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/schema_def" + "$ref": "#/definitions/schema_def_response" } }, "404": { @@ -497,6 +514,60 @@ } } }, + "/schemas/ids/{id}/schema": { + "get": { + "summary": "Get the raw schema by ID.", + "operationId": "get_schemas_ids_id_schema", + "description": "Retrieves only the schema identified by the input ID, without additional metadata.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "type": "integer" + }, + { + "name": "subject", + "in": "query", + "required": false, + "type": "string", + "description": "Optional qualified subject to search for the schema under. Use <:.context:> for context-only lookup, or <:.context:subject> to also verify the schema is associated with that subject. Defaults to searching the default context if unspecified." + }, + { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "description": "Desired output format, dependent on schema type." + } + ], + "produces": [ + "application/vnd.schemaregistry.v1+json", + "application/vnd.schemaregistry+json", + "application/json" + ], + "responses": { + "200": { + "description": "Raw schema string", + "schema": { + "type": "string" + } + }, + "404": { + "description": "Not Found: Schema not found", + "schema": { + "$ref": "#/definitions/error_body" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/error_body" + } + } + } + } + }, "/schemas/ids/{id}/versions": { "get": { "summary": "Get a list of subject-version for the schema ID.", @@ -507,6 +578,13 @@ "in": "path", "required": true, "type": "integer" + }, + { + "name": "subject", + "in": "query", + "required": false, + "type": "string", + "description": "Optional qualified subject to search for the schema under. Use <:.context:> for context-only lookup, or <:.context:subject> to also verify the schema is associated with that subject. Defaults to searching the default context if unspecified." } ], "produces": [ @@ -563,6 +641,13 @@ "in": "query", "required": false, "type": "boolean" + }, + { + "name": "subject", + "in": "query", + "required": false, + "type": "string", + "description": "Optional qualified subject to search for the schema under. Use <:.context:> for context-only lookup, or <:.context:subject> to also verify the schema is associated with that subject. Defaults to searching the default context if unspecified." } ], "produces": [ @@ -608,6 +693,7 @@ }, { "name": "subjectPrefix", + "description": "If specified, only return subjects that start with the given prefix. A plain prefix (e.g. \"my-\") matches subjects in the default context. A context-qualified prefix \":.:\" (e.g. \":.my-context:my-\") matches within a specific context. The wildcard context \":*:\" (e.g. \":*:my-\") matches across all contexts. Use just the context qualifier (e.g. \":.my-context:\" or \":*:\") to list all subjects in a context.", "in": "query", "required": false, "type": "string" @@ -649,6 +735,7 @@ "parameters": [ { "name": "subject", + "description": "The subject name. Use [:.:] for context-qualified subjects, or just for the default context.", "in": "path", "required": true, "type": "string" @@ -676,7 +763,7 @@ "name": "schema_def", "in": "body", "schema": { - "$ref": "#/definitions/schema_def" + "$ref": "#/definitions/schema_def_request" } } ], @@ -689,7 +776,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/stored_schema" + "$ref": "#/definitions/stored_schema_response" } }, "404": { @@ -730,6 +817,7 @@ "parameters": [ { "name": "subject", + "description": "The subject name. Use [:.:] for context-qualified subjects, or just for the default context.", "in": "path", "required": true, "type": "string" @@ -778,6 +866,7 @@ "parameters": [ { "name": "subject", + "description": "The subject name. Use [:.:] for context-qualified subjects, or just for the default context.", "in": "path", "required": true, "type": "string" @@ -829,6 +918,7 @@ "parameters": [ { "name": "subject", + "description": "The subject name. Use [:.:] for context-qualified subjects, or just for the default context.", "in": "path", "required": true, "type": "string" @@ -840,10 +930,10 @@ "type": "boolean" }, { - "name": "schema_def", + "name": "request", "in": "body", "schema": { - "$ref": "#/definitions/stored_schema" + "$ref": "#/definitions/stored_schema_request" } } ], @@ -856,12 +946,7 @@ "200": { "description": "OK", "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - } - } + "$ref": "#/definitions/post_subject_versions_response" } }, "409": { @@ -892,6 +977,7 @@ "parameters": [ { "name": "subject", + "description": "The subject name. Use [:.:] for context-qualified subjects, or just for the default context.", "in": "path", "required": true, "type": "string" @@ -926,7 +1012,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/stored_schema" + "$ref": "#/definitions/get_subject_versions_version_response" } }, "404": { @@ -961,6 +1047,7 @@ "parameters": [ { "name": "subject", + "description": "The subject name. Use [:.:] for context-qualified subjects, or just for the default context.", "in": "path", "required": true, "type": "string" @@ -1020,6 +1107,7 @@ "parameters": [ { "name": "subject", + "description": "The subject name. Use [:.:] for context-qualified subjects, or just for the default context.", "in": "path", "required": true, "type": "string" @@ -1091,6 +1179,7 @@ "parameters": [ { "name": "subject", + "description": "The subject name. Use [:.:] for context-qualified subjects, or just for the default context.", "in": "path", "required": true, "type": "string" @@ -1147,6 +1236,7 @@ "parameters": [ { "name": "subject", + "description": "The subject name. Use [:.:] for context-qualified subjects, or just for the default context.", "in": "path", "required": true, "type": "string" @@ -1207,6 +1297,7 @@ "parameters": [ { "name": "subject", + "description": "The subject name. Use [:.:] for context-qualified subjects, or just for the default context.", "in": "path", "required": true, "type": "string" @@ -1222,7 +1313,7 @@ "name": "schema_def", "in": "body", "schema": { - "$ref": "#/definitions/schema_def" + "$ref": "#/definitions/schema_def_request" } }, { @@ -1280,6 +1371,79 @@ } } }, + "/contexts": { + "get": { + "summary": "List all contexts.", + "operationId": "get_contexts", + "parameters": [], + "produces": [ + "application/vnd.schemaregistry.v1+json", + "application/vnd.schemaregistry+json", + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/error_body" + } + } + } + } + }, + "/contexts/{context}": { + "delete": { + "summary": "Delete a context.", + "description": "Deletes the specified context if it is empty. Subjects must be permanently deleted before the context can be deleted.", + "operationId": "delete_context", + "parameters": [ + { + "name": "context", + "description": "The context to delete (e.g., .staging). Cannot delete the default context.", + "in": "path", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/vnd.schemaregistry.v1+json", + "application/vnd.schemaregistry+json", + "application/json" + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found: Context not found", + "schema": { + "$ref": "#/definitions/error_body" + } + }, + "422": { + "description": "Unprocessable Entity: Context not empty", + "schema": { + "$ref": "#/definitions/error_body" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/error_body" + } + } + } + } + }, "/security/acls": { "get": { "summary": "List ACLs", @@ -1502,7 +1666,52 @@ } } }, - "schema_def": { + "schema_reference": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name used to reference this schema in the dependent schema definition." + }, + "subject": { + "type": "string", + "description": "The subject name of the referenced schema. Use [:.:] for context-qualified subjects, or just for the default context." + }, + "version": { + "type": "integer", + "description": "The version of the referenced schema." + } + } + }, + "schema_metadata_request": { + "type": "object", + "description": "A map of user-defined properties associated with this schema", + "properties": { + "properties": { + "type": "object", + "description": "Accepted values may be string, number, or boolean, they are converted to strings.", + "additionalProperties": { + "oneOf": [ + { "type": "string" }, + { "type": "number" }, + { "type": "boolean" } + ] + } + } + } + }, + "schema_metadata_response": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "schema_def_request": { "type": "object", "properties": { "schema": { @@ -1514,23 +1723,35 @@ "references": { "type": "array", "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "subject": { - "type": "string" - }, - "version": { - "type": "integer" - } - } + "$ref": "#/definitions/schema_reference" + } + }, + "metadata": { + "$ref": "#/definitions/schema_metadata_request" + } + } + }, + "schema_def_response": { + "type": "object", + "properties": { + "schema": { + "type": "string" + }, + "schemaType": { + "type": "string" + }, + "references": { + "type": "array", + "items": { + "$ref": "#/definitions/schema_reference" } + }, + "metadata": { + "$ref": "#/definitions/schema_metadata_response" } } }, - "stored_schema": { + "stored_schema_request": { "type": "object", "properties": { "subject": { @@ -1548,20 +1769,99 @@ "references": { "type": "array", "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "subject": { - "type": "string" - }, - "version": { - "type": "integer" - } - } + "$ref": "#/definitions/schema_reference" } }, + "metadata": { + "$ref": "#/definitions/schema_metadata_request" + }, + "schema": { + "type": "string" + } + } + }, + "stored_schema_response": { + "type": "object", + "properties": { + "subject": { + "type": "string" + }, + "version": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "schemaType": { + "type": "string" + }, + "references": { + "type": "array", + "items": { + "$ref": "#/definitions/schema_reference" + } + }, + "metadata": { + "$ref": "#/definitions/schema_metadata_response" + }, + "schema": { + "type": "string" + } + } + }, + "get_subject_versions_version_response": { + "type": "object", + "properties": { + "subject": { + "type": "string" + }, + "version": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "schemaType": { + "type": "string" + }, + "references": { + "type": "array", + "items": { + "$ref": "#/definitions/schema_reference" + } + }, + "metadata": { + "$ref": "#/definitions/schema_metadata_response" + }, + "schema": { + "type": "string" + }, + "deleted": { + "type": "boolean" + } + } + }, + "post_subject_versions_response": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "version": { + "type": "integer" + }, + "schemaType": { + "type": "string" + }, + "references": { + "type": "array", + "items": { + "$ref": "#/definitions/schema_reference" + } + }, + "metadata": { + "$ref": "#/definitions/schema_metadata_response" + }, "schema": { "type": "string" } @@ -1574,7 +1874,15 @@ "type": "string", "description": "Compatibility level", "example": "FULL_TRANSITIVE", - "enum": ["BACKWARD", "BACKWARD_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "FULL", "FULL_TRANSITIVE", "NONE"] + "enum": [ + "BACKWARD", + "BACKWARD_TRANSITIVE", + "FORWARD", + "FORWARD_TRANSITIVE", + "FULL", + "FULL_TRANSITIVE", + "NONE" + ] } } }, @@ -1585,7 +1893,15 @@ "type": "string", "description": "Compatibility level", "example": "FULL_TRANSITIVE", - "enum": ["BACKWARD", "BACKWARD_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "FULL", "FULL_TRANSITIVE", "NONE"] + "enum": [ + "BACKWARD", + "BACKWARD_TRANSITIVE", + "FORWARD", + "FORWARD_TRANSITIVE", + "FULL", + "FULL_TRANSITIVE", + "NONE" + ] } } }, From 98ab72fa53cbd82c17b3d6a9f9fd54abad0107a6 Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Fri, 17 Apr 2026 11:36:33 -0700 Subject: [PATCH 2/5] Fix invalid oneOf in schema_metadata_request for Swagger 2.0 compliance Replace oneOf (string/number/boolean) with type: string in additionalProperties of schema_metadata_request. The oneOf keyword is not part of the Swagger 2.0 spec and breaks SDK generators. Values are converted to strings by the server, so type: string accurately reflects the API behavior. Co-Authored-By: Claude Opus 4.6 (1M context) --- schema-registry/schema-registry.json | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/schema-registry/schema-registry.json b/schema-registry/schema-registry.json index 92bcc99..dbdc6c3 100644 --- a/schema-registry/schema-registry.json +++ b/schema-registry/schema-registry.json @@ -1691,11 +1691,7 @@ "type": "object", "description": "Accepted values may be string, number, or boolean, they are converted to strings.", "additionalProperties": { - "oneOf": [ - { "type": "string" }, - { "type": "number" }, - { "type": "boolean" } - ] + "type": "string" } } } From 02015d5a42309b0af3007750dad187f3f26c193f Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Fri, 17 Apr 2026 13:29:30 -0700 Subject: [PATCH 3/5] 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) --- schema-registry/overlays/add-external-docs.yaml | 2 +- schema-registry/schema-registry.json | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/schema-registry/overlays/add-external-docs.yaml b/schema-registry/overlays/add-external-docs.yaml index 72af88c..0a0a88c 100644 --- a/schema-registry/overlays/add-external-docs.yaml +++ b/schema-registry/overlays/add-external-docs.yaml @@ -16,4 +16,4 @@ actions: - [Use Redpanda Cloud with the Schema Registry API](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-api/) - [Use Redpanda Self-Managed with the Schema Registry API](https://docs.redpanda.com/current/manage/schema-reg/schema-reg-api/) - 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. \ No newline at end of file + 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. \ No newline at end of file diff --git a/schema-registry/schema-registry.json b/schema-registry/schema-registry.json index dbdc6c3..cd536a7 100644 --- a/schema-registry/schema-registry.json +++ b/schema-registry/schema-registry.json @@ -24,6 +24,7 @@ }, { "name": "defaultToGlobal", + "description": "If true, return the global compatibility level if the subject doesn't have a level set.", "in": "query", "required": false, "type": "boolean" @@ -570,7 +571,7 @@ }, "/schemas/ids/{id}/versions": { "get": { - "summary": "Get a list of subject-version for the schema ID.", + "summary": "Get a list of subject-version pairs for the schema ID.", "operationId": "get_schemas_ids_id_versions", "parameters": [ { @@ -1545,7 +1546,7 @@ }, "post": { "summary": "Create ACLs", - "description": "Create new ACL rules.", + "description": "Create one or more ACL rules. The request body is an array of ACL definitions.", "operationId": "post_security_acls", "parameters": [ { @@ -1689,7 +1690,7 @@ "properties": { "properties": { "type": "object", - "description": "Accepted values may be string, number, or boolean, they are converted to strings.", + "description": "Accepted values may be string, number, or boolean. All values are converted to strings.", "additionalProperties": { "type": "string" } From f2f473d6397116616de2527000069440a3791e88 Mon Sep 17 00:00:00 2001 From: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com> Date: Wed, 22 Apr 2026 09:57:15 -0700 Subject: [PATCH 4/5] Apply suggestion from @pgellert MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Gellért Peresztegi-Nagy --- schema-registry/overlays/add-external-docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema-registry/overlays/add-external-docs.yaml b/schema-registry/overlays/add-external-docs.yaml index 0a0a88c..6419f44 100644 --- a/schema-registry/overlays/add-external-docs.yaml +++ b/schema-registry/overlays/add-external-docs.yaml @@ -16,4 +16,4 @@ actions: - [Use Redpanda Cloud with the Schema Registry API](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-api/) - [Use Redpanda Self-Managed with the Schema Registry API](https://docs.redpanda.com/current/manage/schema-reg/schema-reg-api/) - 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. \ No newline at end of file + Schema Registry contexts (available in Redpanda version 26.1 or later) provide an isolated namespace for schemas, subjects, and configuration. You can 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. \ No newline at end of file From 56dd31688fe7cb12f2a632b12e4c64dbcc1ac528 Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Wed, 22 Apr 2026 18:00:47 -0700 Subject: [PATCH 5/5] Address comments from doc review --- schema-registry/overlays/add-external-docs.yaml | 2 +- schema-registry/schema-registry.json | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/schema-registry/overlays/add-external-docs.yaml b/schema-registry/overlays/add-external-docs.yaml index 6419f44..b8bb1ee 100644 --- a/schema-registry/overlays/add-external-docs.yaml +++ b/schema-registry/overlays/add-external-docs.yaml @@ -16,4 +16,4 @@ actions: - [Use Redpanda Cloud with the Schema Registry API](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-api/) - [Use Redpanda Self-Managed with the Schema Registry API](https://docs.redpanda.com/current/manage/schema-reg/schema-reg-api/) - Schema Registry contexts (available in Redpanda version 26.1 or later) provide an isolated namespace for schemas, subjects, and configuration. You can 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. \ No newline at end of file + Schema Registry contexts (available in Redpanda version 26.1 or later) provide an isolated namespace for schemas, subjects, and configuration. You can use a context-qualified subject anywhere the API accepts a subject. In Redpanda Cloud, contexts are configurable only in BYOC and Dedicated clusters. See the [Redpanda Cloud](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-contexts/) or [Redpanda Self-Managed](https://docs.redpanda.com/current/manage/schema-reg/schema-reg-contexts/) documentation for details. \ No newline at end of file diff --git a/schema-registry/schema-registry.json b/schema-registry/schema-registry.json index cd536a7..598b38c 100644 --- a/schema-registry/schema-registry.json +++ b/schema-registry/schema-registry.json @@ -472,7 +472,7 @@ "in": "query", "required": false, "type": "string", - "description": "Optional qualified subject to search for the schema under. Use <:.context:> for context-only lookup, or <:.context:subject> to also verify the schema is associated with that subject. Defaults to searching the default context if unspecified." + "description": "Qualified subject to scope the lookup. Use :.: for context-only lookup, or :.: to also verify the schema is associated with that subject. Defaults to searching the default context if unspecified." }, { "name": "referenceFormat", @@ -532,7 +532,7 @@ "in": "query", "required": false, "type": "string", - "description": "Optional qualified subject to search for the schema under. Use <:.context:> for context-only lookup, or <:.context:subject> to also verify the schema is associated with that subject. Defaults to searching the default context if unspecified." + "description": "Qualified subject to scope the lookup. Use :.: for context-only lookup, or :.: to also verify the schema is associated with that subject. Defaults to searching the default context if unspecified." }, { "name": "format", @@ -585,7 +585,7 @@ "in": "query", "required": false, "type": "string", - "description": "Optional qualified subject to search for the schema under. Use <:.context:> for context-only lookup, or <:.context:subject> to also verify the schema is associated with that subject. Defaults to searching the default context if unspecified." + "description": "Qualified subject to scope the lookup. Use :.: for context-only lookup, or :.: to also verify the schema is associated with that subject. Defaults to searching the default context if unspecified." } ], "produces": [ @@ -648,7 +648,7 @@ "in": "query", "required": false, "type": "string", - "description": "Optional qualified subject to search for the schema under. Use <:.context:> for context-only lookup, or <:.context:subject> to also verify the schema is associated with that subject. Defaults to searching the default context if unspecified." + "description": "Qualified subject to scope the lookup. Use :.: for context-only lookup, or :.: to also verify the schema is associated with that subject. Defaults to searching the default context if unspecified." } ], "produces": [