Skip to content

Commit 9c38635

Browse files
avalerio-tkdavalerio-tkd
committed
- Fixing examples on swagger.yaml
1 parent 96130e9 commit 9c38635

1 file changed

Lines changed: 42 additions & 37 deletions

File tree

‎src/common/swagger.yaml‎

Lines changed: 42 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -112,29 +112,30 @@ paths:
112112
int32_data_page_v1_uncompressed:
113113
summary: "INT32 · DATA_PAGE_V1 · UNCOMPRESSED · PLAIN"
114114
description: >
115-
Three INT32 values [198423, 55102, 7839201] encoded as
116-
PLAIN in an uncompressed DATA_PAGE_V1. Definition and
117-
repetition levels use RLE encoding. Max definition level
118-
is 2 (nested nullable), max repetition level is 1
119-
(one repeated ancestor).
115+
Five INT32 values [198423, 55102, 7839201, 4410, 983567]
116+
encoded as PLAIN in an uncompressed DATA_PAGE_V1 with
117+
RLE-encoded level bytes. Max definition level is 2
118+
(nested nullable), max repetition level is 1 (one
119+
repeated ancestor). Repetition levels [0,1,1,0,1],
120+
definition levels all 2 (all present).
120121
value:
121122
column_reference:
122123
name: invoice_amount
123124
data_batch:
124125
datatype_info:
125126
datatype: INT32
126-
value: FwcDAD7XAADhnXcA
127+
value: CAAAAAIABAECAAIBAgAAAAoCFwcDAD7XAADhnXcAOhEAAA8CDwA=
127128
value_format:
128129
compression: UNCOMPRESSED
129130
encoding: PLAIN
130131
encoding_attributes:
131132
page_encoding: PLAIN
132133
page_type: DATA_PAGE_V1
133-
data_page_num_values: "3"
134+
data_page_num_values: "5"
134135
data_page_max_definition_level: "2"
135136
data_page_max_repetition_level: "1"
136137
page_v1_definition_level_encoding: RLE
137-
page_v1_repetition_level_encoding: BIT_PACKED
138+
page_v1_repetition_level_encoding: RLE
138139
data_batch_encrypted:
139140
value_format:
140141
compression: UNCOMPRESSED
@@ -149,18 +150,19 @@ paths:
149150
int32_data_page_v2_snappy:
150151
summary: "INT32 · DATA_PAGE_V2 · SNAPPY · PLAIN"
151152
description: >
152-
Three INT32 values [198423, 55102, 7839201] in a
153-
SNAPPY-compressed DATA_PAGE_V2. Definition levels
154-
occupy 6 bytes, repetition levels 4 bytes. Two null
155-
values present. page_v2_is_compressed is true because
156-
the data section is SNAPPY-compressed.
153+
Five logical values in a SNAPPY-compressed DATA_PAGE_V2.
154+
Definition levels [2,2,0,2,0] — 3 present, 2 null.
155+
Repetition levels [0,1,0,0,1]. Level bytes are
156+
uncompressed (8 bytes each), only value section is
157+
SNAPPY-compressed. Value bytes contain 3 INT32s
158+
[198423, 55102, 7839201].
157159
value:
158160
column_reference:
159161
name: invoice_amount
160162
data_batch:
161163
datatype_info:
162164
datatype: INT32
163-
value: FwcDAD7XAADhnXcA
165+
value: AgACAQQAAgEEAgIAAgICABcHAwA+1wAA4Z13AA==
164166
value_format:
165167
compression: SNAPPY
166168
encoding: PLAIN
@@ -170,8 +172,8 @@ paths:
170172
data_page_num_values: "5"
171173
data_page_max_definition_level: "2"
172174
data_page_max_repetition_level: "1"
173-
page_v2_definition_levels_byte_length: "6"
174-
page_v2_repetition_levels_byte_length: "4"
175+
page_v2_definition_levels_byte_length: "8"
176+
page_v2_repetition_levels_byte_length: "8"
175177
page_v2_num_nulls: "2"
176178
page_v2_is_compressed: "true"
177179
data_batch_encrypted:
@@ -190,16 +192,17 @@ paths:
190192
description: >
191193
Two BYTE_ARRAY values ["jdoe@acme.org",
192194
"alice.wong@corp.net"] in PLAIN encoding, uncompressed
193-
DATA_PAGE_V1. Each value is length-prefixed (4-byte
194-
little-endian length followed by the raw bytes).
195-
Max definition level 3, repetition level 0 (flat schema).
195+
DATA_PAGE_V1 with RLE-encoded definition levels. Each
196+
value is length-prefixed (4-byte LE length + raw bytes).
197+
Max definition level 3 (deeply nullable), repetition
198+
level 0 (flat schema — no rep level bytes).
196199
value:
197200
column_reference:
198201
name: contact_email
199202
data_batch:
200203
datatype_info:
201204
datatype: BYTE_ARRAY
202-
value: DQAAAGpkb2VAYWNtZS5vcmcTAAAAYWxpY2Uud29uZ0Bjb3JwLm5ldA==
205+
value: AgAAAAQDDQAAAGpkb2VAYWNtZS5vcmcTAAAAYWxpY2Uud29uZ0Bjb3JwLm5ldA==
203206
value_format:
204207
compression: UNCOMPRESSED
205208
encoding: PLAIN
@@ -258,17 +261,19 @@ paths:
258261
byte_array_data_page_v2_snappy:
259262
summary: "BYTE_ARRAY · DATA_PAGE_V2 · SNAPPY · PLAIN"
260263
description: >
261-
Two non-null BYTE_ARRAY values ["jdoe@acme.org",
262-
"alice.wong@corp.net"] plus one null in a
263-
SNAPPY-compressed DATA_PAGE_V2. Definition levels
264-
occupy 8 bytes, repetition levels 0 bytes.
264+
Three logical values — two non-null BYTE_ARRAY
265+
["jdoe@acme.org", "alice.wong@corp.net"] plus one null
266+
— in a SNAPPY-compressed DATA_PAGE_V2. Definition
267+
levels [3,3,0] occupy 4 RLE-encoded bytes, repetition
268+
levels 0 bytes (flat schema). Only value section is
269+
SNAPPY-compressed.
265270
value:
266271
column_reference:
267272
name: contact_email
268273
data_batch:
269274
datatype_info:
270275
datatype: BYTE_ARRAY
271-
value: DQAAAGpkb2VAYWNtZS5vcmcTAAAAYWxpY2Uud29uZ0Bjb3JwLm5ldA==
276+
value: BAMCAA0AAABqZG9lQGFjbWUub3JnEwAAAGFsaWNlLndvbmdAY29ycC5uZXQ=
272277
value_format:
273278
compression: SNAPPY
274279
encoding: PLAIN
@@ -278,7 +283,7 @@ paths:
278283
data_page_num_values: "3"
279284
data_page_max_definition_level: "3"
280285
data_page_max_repetition_level: "0"
281-
page_v2_definition_levels_byte_length: "8"
286+
page_v2_definition_levels_byte_length: "4"
282287
page_v2_repetition_levels_byte_length: "0"
283288
page_v2_num_nulls: "1"
284289
page_v2_is_compressed: "true"
@@ -381,10 +386,10 @@ paths:
381386
int32_data_page_v1_uncompressed:
382387
summary: "INT32 · DATA_PAGE_V1 · UNCOMPRESSED · PLAIN"
383388
description: >
384-
Decrypt the ciphertext produced by encrypting three INT32
385-
values [198423, 55102, 7839201] in an uncompressed
386-
DATA_PAGE_V1. The encryption_metadata is passed back
387-
verbatim from the encrypt response.
389+
Decrypt the ciphertext produced by encrypting five INT32
390+
values in an uncompressed DATA_PAGE_V1. The
391+
encryption_metadata is passed back verbatim from the
392+
encrypt response.
388393
value:
389394
column_reference:
390395
name: invoice_amount
@@ -397,11 +402,11 @@ paths:
397402
encoding_attributes:
398403
page_encoding: PLAIN
399404
page_type: DATA_PAGE_V1
400-
data_page_num_values: "3"
405+
data_page_num_values: "5"
401406
data_page_max_definition_level: "2"
402407
data_page_max_repetition_level: "1"
403408
page_v1_definition_level_encoding: RLE
404-
page_v1_repetition_level_encoding: BIT_PACKED
409+
page_v1_repetition_level_encoding: RLE
405410
data_batch_encrypted:
406411
value: hzHDFbkE1nYiapYxTt+cVKZncO5oIqv0qqXIJoPxhJ4=
407412
value_format:
@@ -437,8 +442,8 @@ paths:
437442
data_page_num_values: "5"
438443
data_page_max_definition_level: "2"
439444
data_page_max_repetition_level: "1"
440-
page_v2_definition_levels_byte_length: "6"
441-
page_v2_repetition_levels_byte_length: "4"
445+
page_v2_definition_levels_byte_length: "8"
446+
page_v2_repetition_levels_byte_length: "8"
442447
page_v2_num_nulls: "2"
443448
page_v2_is_compressed: "true"
444449
data_batch_encrypted:
@@ -546,7 +551,7 @@ paths:
546551
data_page_num_values: "3"
547552
data_page_max_definition_level: "3"
548553
data_page_max_repetition_level: "0"
549-
page_v2_definition_levels_byte_length: "8"
554+
page_v2_definition_levels_byte_length: "4"
550555
page_v2_repetition_levels_byte_length: "0"
551556
page_v2_num_nulls: "1"
552557
page_v2_is_compressed: "true"
@@ -580,7 +585,7 @@ paths:
580585
data_batch:
581586
datatype_info:
582587
datatype: INT32
583-
value: FwcDAD7XAADhnXcA
588+
value: CAAAAAIABAECAAIBAgAAAAoCFwcDAD7XAADhnXcAOhEAAA8CDwA=
584589
value_format:
585590
compression: UNCOMPRESSED
586591
encoding: PLAIN
@@ -597,7 +602,7 @@ paths:
597602
data_batch:
598603
datatype_info:
599604
datatype: BYTE_ARRAY
600-
value: DQAAAGpkb2VAYWNtZS5vcmcTAAAAYWxpY2Uud29uZ0Bjb3JwLm5ldA==
605+
value: AgAAAAQDDQAAAGpkb2VAYWNtZS5vcmcTAAAAYWxpY2Uud29uZ0Bjb3JwLm5ldA==
601606
value_format:
602607
compression: UNCOMPRESSED
603608
encoding: PLAIN

0 commit comments

Comments
 (0)