From cb6efd106bca811631db77973f8b6dc5b301c66c Mon Sep 17 00:00:00 2001 From: Michael Ernest Date: Tue, 17 Mar 2026 12:09:51 -0700 Subject: [PATCH] fix(DOC-2061): clarify schema reference name field per schema type Add a table explaining what the `name` field means in schema references for Protobuf (import path), Avro (fully qualified schema name), and JSON Schema (URI used in $ref). Co-Authored-By: Claude Sonnet 4.6 --- .../pages/schema-reg/schema-reg-api.adoc | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/modules/manage/pages/schema-reg/schema-reg-api.adoc b/modules/manage/pages/schema-reg/schema-reg-api.adoc index 6a8f7546e6..f9c3dfbfb8 100644 --- a/modules/manage/pages/schema-reg/schema-reg-api.adoc +++ b/modules/manage/pages/schema-reg/schema-reg-api.adoc @@ -648,7 +648,23 @@ A successful registration returns the schema's `id`: == Reference a schema -To build more complex schema definitions, you can add a reference to other schemas. The following example registers a Protobuf schema in subject `test-simple` with a message name `Simple`. +To build more complex schema definitions, you can add a reference to other schemas. A reference identifies another schema using a `name`, `subject`, and `version`. The meaning of `name` depends on the schema type: + +[cols="1,2"] +|=== +| Schema type | Reference name + +| Protobuf +| The import path used in the `.proto` file (for example, `import "simple";` uses name `simple`) + +| Avro +| The fully qualified schema name, combining the namespace and record name (for example, `com.example.Address`) + +| JSON Schema +| A URI used in `$ref` to identify the referenced schema +|=== + +The following example registers a Protobuf schema in subject `test-simple` with a message name `Simple`. [tabs] ====