This is an automated email from the ASF dual-hosted git repository.
opwvhk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/avro.git
The following commit(s) were added to refs/heads/main by this push:
new ec698a515 Remove 'default' from map and array examples (and add to
enum). (#3046)
ec698a515 is described below
commit ec698a51582756fba105d6516828e235d1d1b93c
Author: Huw Campbell <[email protected]>
AuthorDate: Thu Aug 29 17:00:11 2024 +1000
Remove 'default' from map and array examples (and add to enum). (#3046)
Default values are not valid for maps and arrays, and are only
valid for record fields (and enums, though that's a different story).
Having it in the examples is confusing, as people might
have expectations around it behaving in a certain way.
In the Java and Rust implementation, a default value listed here
will be packed into the custom props and attributes payloads, and
do not need to be of the same type.
---
.../en/docs/++version++/Specification/_index.md | 21 ++++++++++-----------
1 file changed, 10 insertions(+), 11 deletions(-)
diff --git a/doc/content/en/docs/++version++/Specification/_index.md
b/doc/content/en/docs/++version++/Specification/_index.md
index 75eda7b7f..d9199c340 100755
--- a/doc/content/en/docs/++version++/Specification/_index.md
+++ b/doc/content/en/docs/++version++/Specification/_index.md
@@ -107,7 +107,7 @@ For example, a linked-list of 64-bit values may be defined
with:
]
}
```
-
+
### Enums
Enums use the type name "enum" and support the following attributes:
@@ -123,10 +123,11 @@ For example, playing card suits might be defined with:
{
"type": "enum",
"name": "Suit",
- "symbols" : ["SPADES", "HEARTS", "DIAMONDS", "CLUBS"]
+ "symbols" : ["SPADES", "HEARTS", "DIAMONDS", "CLUBS"],
+ "default" : "CLUBS"
}
```
-
+
### Arrays
Arrays use the type name "array" and support a single attribute:
@@ -137,10 +138,9 @@ For example, an array of strings is declared with:
{
"type": "array",
"items" : "string",
- "default": []
}
```
-
+
### Maps
Maps use the type name "map" and support one attribute:
@@ -153,10 +153,9 @@ For example, a map from string to long is declared with:
{
"type": "map",
"values" : "long",
- "default": {}
}
```
-
+
### Unions
Unions, as mentioned above, are represented using JSON arrays. For example,
`["null", "string"]` declares a schema which may be either a null or string.
@@ -340,7 +339,7 @@ For example, the record schema
]
}
```
-
+
An instance of this record whose a field has value 27 (encoded as hex 36) and
whose b field has value "foo" (encoded as hex bytes 06 66 6f 6f), would be
encoded simply as the concatenation of these, namely the hex byte sequence:
```
36 06 66 6f 6f
@@ -479,7 +478,7 @@ A file header is thus described by the following schema:
]
}
```
-
+
A file data block consists of:
* A long indicating the count of objects in this block.
@@ -578,7 +577,7 @@ For example, one may define a simple HelloWorld protocol
with:
}
}
```
-
+
## Protocol Wire Format
### Message Transport
@@ -651,7 +650,7 @@ The handshake process uses the following record schemas:
]
}
```
-
+
* A client first prefixes each request with a `HandshakeRequest` containing
just the hash of its protocol and of the server's protocol (`clientHash!=null,
clientProtocol=null, serverHash!=null`), where the hashes are 128-bit MD5
hashes of the JSON protocol text. If a client has never connected to a given
server, it sends its hash as a guess of the server's hash, otherwise it sends
the hash that it previously obtained from this server.
The server responds with a HandshakeResponse containing one of:
* `match=BOTH, serverProtocol=null, serverHash=null` if the client sent the
valid hash of the server's protocol and the server knows what protocol
corresponds to the client's hash. In this case, the request is complete and the
response data immediately follows the HandshakeResponse.
