You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by ke...@apache.org on 2024/09/07 22:27:35 UTC
(tinkerpop) branch v4-io-format updated: formatting'
This is an automated email from the ASF dual-hosted git repository.
kenhuuu pushed a commit to branch v4-io-format
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
The following commit(s) were added to refs/heads/v4-io-format by this push:
new 8f9498c9ac formatting'
8f9498c9ac is described below
commit 8f9498c9acb960b095863285b68917544e5ade9b
Author: Ken Hu <10...@users.noreply.github.com>
AuthorDate: Sat Sep 7 15:27:18 2024 -0700
formatting'
---
docs/src/dev/io/graphson.asciidoc | 40 ++++++++++++++++-----------------
docs/src/upgrade/release-4.x.x.asciidoc | 2 ++
2 files changed, 22 insertions(+), 20 deletions(-)
diff --git a/docs/src/dev/io/graphson.asciidoc b/docs/src/dev/io/graphson.asciidoc
index f3f060a535..e12f830c07 100644
--- a/docs/src/dev/io/graphson.asciidoc
+++ b/docs/src/dev/io/graphson.asciidoc
@@ -124,8 +124,8 @@ true
==== Composite PDT
-JSON Object with two required keys: "type" and "fields"+
-"type" is a JSON String+
+JSON Object with two required keys: "type" and "fields" +
+"type" is a JSON String +
"fields" is a `g:Map`
[source,json]
@@ -341,8 +341,8 @@ null
==== Primitive PDT
-JSON Object with two required keys: "type" and "value"+
-"type" is a JSON String+
+JSON Object with two required keys: "type" and "value" +
+"type" is a JSON String +
"value" is a JSON String
[source,json]
@@ -424,9 +424,9 @@ JSON String form of UUID.
==== Edge
-JSON Object (required keys are: id, label, inVLabel, outVLabel, inV, outV, properties)+
-"id", "inV", "outV" is any GraphSON 4.0 type+
-"label", "inVLabel", "outVLabel" value is a `g:List` of `String`+
+JSON Object (required keys are: id, label, inVLabel, outVLabel, inV, outV, properties) +
+"id", "inV", "outV" is any GraphSON 4.0 type +
+"label", "inVLabel", "outVLabel" value is a `g:List` of `String` +
"properties" is an Object containing "name" to `g:Property` mappings
The untyped version has one additional required key "type" which is always "vertex".
@@ -507,8 +507,8 @@ The untyped version has one additional required key "type" which is always "vert
==== Graph
`TinkerGraph` has a custom serializer that is registered as part of the `TinkerIoRegistry`. Graph is a JSON Object with
-two required keys: "vertices" and "edges"+
-"vertices" is an Array of `g:Vertex`+
+two required keys: "vertices" and "edges" +
+"vertices" is an Array of `g:Vertex` +
"edges" is an Array of `g:Edge`
[source,json]
@@ -2203,8 +2203,8 @@ two required keys: "vertices" and "edges"+
==== Path
-Object with two required keys: "labels" and "objects"+
-"labels" is a `g:List` of `g:Set` of labels of the steps traversed+
+Object with two required keys: "labels" and "objects" +
+"labels" is a `g:List` of `g:Set` of labels of the steps traversed +
"objects" is a `g:List` of objects traversed
[source,json]
@@ -2319,8 +2319,8 @@ Object with two required keys: "labels" and "objects"+
==== Property
-JSON Object with two required keys: "key" and "value"+
-"key" is a `String`
+JSON Object with two required keys: "key" and "value" +
+"key" is a `String` +
"value" is any GraphSON 4.0 type
[source,json]
@@ -2488,9 +2488,9 @@ JSON Object with one or more possibly nested "key" "value" pairs
==== Vertex
-JSON Object with required keys: "id", "label", "properties"+
-"id" is any GraphSON 4.0 type+
-"label" is a `g:List` of `String`+
+JSON Object with required keys: "id", "label", "properties" +
+"id" is any GraphSON 4.0 type +
+"label" is a `g:List` of `String` +
"properties" is an Object containing Arrays of `g:VertexProperty`
The untyped version has one additional required key "type" which is always "vertex".
@@ -2690,10 +2690,10 @@ The untyped version has one additional required key "type" which is always "vert
==== VertexProperty
-JOSN Object with required keys: "id", "value", "label", "properties"+
-"id" is any type GraphSON 4.0 type+
-"value" is any type GraphSON 4.0 type+
-"label" is a `g:List` of `String`+
+JOSN Object with required keys: "id", "value", "label", "properties" +
+"id" is any type GraphSON 4.0 type +
+"value" is any type GraphSON 4.0 type +
+"label" is a `g:List` of `String` +
"properties" contains an Array of "g:Property" (metaproperties)
[source,json]
diff --git a/docs/src/upgrade/release-4.x.x.asciidoc b/docs/src/upgrade/release-4.x.x.asciidoc
index e1e018cd46..377f002530 100644
--- a/docs/src/upgrade/release-4.x.x.asciidoc
+++ b/docs/src/upgrade/release-4.x.x.asciidoc
@@ -196,6 +196,7 @@ no elements matching the predicate.
The V4 versions of GraphBinary and GraphSON are being introduced. Support for the older versions of GraphBinary (V1) and GraphSON (V1-3) is removed.
Additionally, the GLVs will only use GraphBinary, the Gremlin Server, however, can still serialize both GraphSON and GraphBinary.
The following is a list of the major changes to the GraphBinary format:
+
- Removed type serializers:
- Period
- Date
@@ -232,6 +233,7 @@ The following is a list of the major changes to the GraphBinary format:
- Metrics
- TraversalMetrics
- InetAddress
+
- Byte is redefined from being unsigned byte to a signed byte.
- List has a `0x02` value_flag used to denote bulking.
- Map has a `0x02` value_flag used to denote ordering.