5.23 Release. New GQLStatusObject API (neo4j#168)

Co-authored-by: Reneta Popova <[email protected]>
Co-authored-by: Louise Berglund <[email protected]>
Co-authored-by: Neil Dewhurst <[email protected]>

Author: 4 people

.github/workflows/docs-pr-checks.yml

@@ -7,6 +7,7 @@ on:
     - "dev"
     - "5.x"
     - "4.[0-9]"
+    - "gql-notifications"
 
 jobs:
 

.github/workflows/docs-teardown.yml

@@ -7,6 +7,7 @@ on:
       - "dev"
       - "5.x"
       - "4.[0-9]"
+      - "gql-notifications"
     types:
       - closed
 

antora.yml

@@ -7,6 +7,6 @@ nav:
 asciidoc:
   attributes:
     page-origin-private: false
-    neo4j-version: '5.22'
-    neo4j-version-exact: '5.22.0'
-    neo4j-buildnumber: '5.22'
+    neo4j-version: '5.23'
+    neo4j-version-exact: '5.23.0'
+    neo4j-buildnumber: '5.23'

modules/ROOT/content-nav.adoc

@@ -1,8 +1,8 @@
 * xref:index.adoc[]
-** xref:errors/index.adoc[]
-*** xref:errors/all-errors.adoc[]
-** xref:notifications/index.adoc[]
-*** xref:notifications/all-notifications.adoc[]
-** xref:changelogs.adoc[]
+* xref:errors/index.adoc[]
+** xref:errors/all-errors.adoc[]
+* xref:notifications/index.adoc[]
+** xref:notifications/all-notifications.adoc[]
+* xref:changelogs.adoc[]
 
 

modules/ROOT/pages/changelogs.adoc

@@ -1,6 +1,14 @@
 :description: This page lists all changes to status codes per Neo4j version.
 = Changes to status codes per Neo4j version
 
+== Neo4j 5.23
+
+From version 5.23, Neo4j has a new GqlStatusObject API in addition to the existing Notification API.
+
+The GqlStatusObject API provides information about the status of a Cypher query or command execution in compliance with the GQL standard.
+It includes GQLSTATUS code, StatusDescription, and DiagnosticRecord.
+For more information, see xref:notifications/index.adoc#gqlstatus-notification-object[GQL-status notification object].
+
 == Neo4j 5.17
 
 **New:**

modules/ROOT/pages/errors/all-errors.adoc

@@ -2,7 +2,7 @@
 
 
 [[neo4j-errors]]
-= List of all error codes
+= List of all server error codes
 
 This page contains lists of all Neo4j errors, grouped by type.
 

modules/ROOT/pages/errors/index.adoc

@@ -1,7 +1,7 @@
 :description: The Neo4j error codes for Neo4j version {neo4j-version}.
 
-[[notifications]]
-= Error codes
+[[error-codes]]
+= Server errors
 
 Error codes are Neo4j status codes returned by the server when the execution of a query fails.
 They always have the severity level `ERROR`.

modules/ROOT/pages/index.adoc

@@ -1,10 +1,18 @@
+
+[[status-codes]]
+ifdef::backend-pdf[]
+= Neo4j 5 Status Codes
+endif::[]
+ifndef::backend-pdf[]
+= Introduction
+endif::[]
 :description: The Neo4j status codes for Neo4j version {neo4j-version}.
 :neo4j-buildnumber: {neo4j-version}
-[[status-codes]]
-= Neo4j Status Codes v5
+
 
 This document details all status codes that a Neo4j DBMS may return to indicate the outcome of a request.
 
+
 == Format
 
 Each Neo4j status code follows the same format:
@@ -14,6 +22,7 @@ Each Neo4j status code follows the same format:
 Neo.[Type].[SubType].[Name]
 -----
 
+
 == Types of Neo4j status codes
 
 The fact that a Neo4j status code is returned by the server does not always mean there is a fatal error.
@@ -46,6 +55,14 @@ The type of the status code determines the effect on the transaction.
 
 |===
 
+[NOTE]
+====
+From version 5.23, Neo4j has a new GqlStatusObject API in addition to the existing Notification API.
+
+The GqlStatusObject API provides information about the status of a Cypher query or command execution in compliance with the GQL standard.
+It includes GQLSTATUS code, StatusDescription, and DiagnosticRecord.
+For more information, see xref:notifications/index.adoc#gqlstatus-notification-object[GQL-status notification object].
+====
 
 ifndef::backend-pdf[]
 License: link:{common-license-page-uri}[Creative Commons 4.0]