From f6c772e4e70e61ec2596d6f39406df81b4e1616d Mon Sep 17 00:00:00 2001
From: Andy Li <1450947+andy1li@users.noreply.github.com>
Date: Tue, 10 Jun 2025 01:50:21 +0800
Subject: [PATCH] Add representation details for `records` field in
 course-definition.yml

Updated the documentation to specify that the `records` field is represented as `COMPACT_NULLABLE_BYTES`, including details about its structure and length.
---
 course-definition.yml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/course-definition.yml b/course-definition.yml
index 6dbfcdc..22a2a7b 100644
--- a/course-definition.yml
+++ b/course-definition.yml
@@ -858,6 +858,7 @@ stages:
           - The `partition_index` field is `0`.
           - The `error_code` field is `0` (No Error).
           - The `records` array has 1 element.
+            - The `records` field is represented as `COMPACT_NULLABLE_BYTES`. It starts with an UNSIGNED_VARINT length of N+1, followed by N bytes.
             - The entire `RecordBatch` content is read from disk. (We will compare the contents of the `RecordBatch` with the contents of the log file to verify this.)
 
       ### Notes
@@ -904,6 +905,7 @@ stages:
           - The `partition_index` field matches what was sent in the request.
           - The `error_code` field is `0` (No Error).
           - The `records` array has the correct number of elements.
+            - The `records` field is represented as `COMPACT_NULLABLE_BYTES`. It starts with an UNSIGNED_VARINT length of N+1, followed by N bytes.
             - The entire `RecordBatch` content is read from disk. (We will compare the contents of the `RecordBatch` with the contents of the log file to verify this.)
 
       ### Notes