Skip to content

Commit f6c772e

Browse files
committed
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.
1 parent 3da8b89 commit f6c772e

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

course-definition.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -858,6 +858,7 @@ stages:
858858
- The `partition_index` field is `0`.
859859
- The `error_code` field is `0` (No Error).
860860
- The `records` array has 1 element.
861+
- The `records` field is represented as `COMPACT_NULLABLE_BYTES`. It starts with an UNSIGNED_VARINT length of N+1, followed by N bytes.
861862
- 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.)
862863
863864
### Notes
@@ -904,6 +905,7 @@ stages:
904905
- The `partition_index` field matches what was sent in the request.
905906
- The `error_code` field is `0` (No Error).
906907
- The `records` array has the correct number of elements.
908+
- The `records` field is represented as `COMPACT_NULLABLE_BYTES`. It starts with an UNSIGNED_VARINT length of N+1, followed by N bytes.
907909
- 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.)
908910
909911
### Notes

0 commit comments

Comments
 (0)