Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ asciidoc:
attributes:
page-origin-private: false
neo4j-version: '5'
typed-json-version: 'vnd.neo4j.query.v1.2'
6 changes: 6 additions & 0 deletions modules/ROOT/pages/changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

= Changelog

[#typed-json-version-1-2]
[role=label--new-2026.07]
== application/vnd.neo4j.query.v1.2

- Introduce `UUID` type.

[#typed-json-version-1-1]
[role=label--new-2025.11]
== application/vnd.neo4j.query.v1.1
Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/headers.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This page contains a full list of headers you may use to tweak the API behavior,

|Accept
|Desired format of the response body. +
Possible values are `application/json`, `application/vnd.neo4j.query.v1.1`, and `application/vnd.neo4j.query.v1.0`. +
Possible values are `application/json`, `application/vnd.neo4j.query.v1.2`, `application/vnd.neo4j.query.v1.1`, and `application/vnd.neo4j.query.v1.0`. +
For more information, see xref:plain-json.adoc[] and xref:typed-json.adoc[].

|Authorization
Expand All @@ -19,7 +19,7 @@ For more information, see xref:authentication-authorization.adoc[].

|Content-Type
|The format of the request body. +
Possible values are `application/json`, `application/vnd.neo4j.query.v1.1`, and `application/vnd.neo4j.query.v1.0`. +
Possible values are `application/json`, `application/vnd.neo4j.query.v1.2`, `application/vnd.neo4j.query.v1.1`, and `application/vnd.neo4j.query.v1.0`. +
For more information, see xref:plain-json.adoc[] and xref:typed-json.adoc[].

|neo4j-cluster-affinity
Expand All @@ -38,7 +38,7 @@ For more information, see xref:transactions.adoc[].

|Content-Type
|The format of the response body (matches the `Accept` request header). +
Possible values are `application/json`, `application/vnd.neo4j.query.v1.1`, and `application/vnd.neo4j.query.v1.0`. +
Possible values are `application/json`, `application/vnd.neo4j.query.v1.2`, `application/vnd.neo4j.query.v1.1`, and `application/vnd.neo4j.query.v1.0`. +
For more information, see xref:plain-json.adoc[] and xref:typed-json.adoc[].

|neo4j-cluster-affinity
Expand Down
14 changes: 14 additions & 0 deletions modules/ROOT/pages/plain-json.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -269,4 +269,18 @@ label:enterprise-edition[] label:new[Introduced in 2025.10]
[NOTE]
link:https://neo4j.com/docs/cypher-manual/current/values-and-types/vector/[`VECTOR`] values can only be retrieved from the database, but cannot be passed as parameters in Plain JSON.
To create vectors, use the link:https://neo4j.com/docs/cypher-manual/current/values-and-types/vector/#construct-vector-values[Cypher `vector` constructor], or use the xref:typed-json.adoc[Typed JSON result format].

| UUID
| string (ISO-9834)
| [source, JSON]
----
"550e8400-e29b-41d4-a716-446655440000"
"00000000-0000-0000-0000-000000000000"
----

label:new[Introduced in 2026.07]

[NOTE]
UUID values can only be retrieved from the database in plain JSON format. To pass them as parameters, use xref:typed-json.adoc[typed JSON].

|===
2 changes: 1 addition & 1 deletion modules/ROOT/pages/streaming.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This allows clients to process data incrementally as it arrives, improving memor
You enable streaming by tweaking the `Accept` header:

* For xref:plain-json.adoc[Plain JSON], `application/jsonl`.
* For xref:typed-json.adoc[Typed JSON], add the suffix `+jsonl`. For example, `application/vnd.neo4j.query.v1.1+jsonl`.
* For xref:typed-json.adoc[Typed JSON], add the suffix `+jsonl`. For example, `{typed-json-version}+jsonl`.

[NOTE]
For clarity, JSON objects in this page are formatted with line breaks.
Expand Down
25 changes: 18 additions & 7 deletions modules/ROOT/pages/typed-json.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ If you care about what type each returned value is, you can use Neo4j's extended
[[enable]]
== Enable Typed JSON

To receive the result in Typed JSON format, set `Accept: application/vnd.neo4j.query.v1.1` in the request headers.
To receive the result in Typed JSON format, set `Accept: application/{typed-json-version}` in the request headers.

In this format, each return value is an object where the type and value information are stored as separate keys:

Expand All @@ -45,7 +45,7 @@ In this format, each return value is an object where the type and value informat
}
----

If you wish to also submit parameters with this format, set `Content-Type: application/vnd.neo4j.query.v1.1` in the request headers.
If you wish to also submit parameters with this format, set `Content-Type: application/{typed-json-version}` in the request headers.


[[examples]]
Expand All @@ -56,12 +56,12 @@ If you wish to also submit parameters with this format, set `Content-Type: appli
[discrete]
=== Example request

[source, headers]
[source, headers, subs="attributes+"]
----
POST http://localhost:7474/db/neo4j/query/v2
Authorization: Basic bmVvNGo6dmVyeXNlY3JldA==
Accept: application/vnd.neo4j.query.v1.1
Content-Type: application/vnd.neo4j.query.v1.1
Accept: application/{typed-json-version}
Content-Type: application/{typed-json-version}
----

[source, JSON]
Expand All @@ -80,10 +80,10 @@ Content-Type: application/vnd.neo4j.query.v1.1
[discrete]
=== Example response

[source, headers]
[source, headers, subs="attributes+"]
----
202: Accepted
Content-Type: application/vnd.neo4j.query.v1.1
Content-Type: application/{typed-json-version}
----

[source, JSON]
Expand Down Expand Up @@ -485,4 +485,15 @@ The dimension of the vector is implicitly defined by the length of the `coordina
----
label:new[Introduced in 2025.11]

| UUID
| UUID
| [source, JSON]
----
{
"$type": "UUID",
"_value": "550e8400-e29b-41d4-a716-446655440000"
}
----
label:new[Introduced in 2026.07]

|===