Add a warning that parsing status descriptions is not recommended (#228)

Co-authored-by: Louise Berglund <[email protected]>
neo4j · Nov 29, 2024 · 58fbb09 · 58fbb09
1 parent 76b6273
commit 58fbb09
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/modules/ROOT/pages/errors/gql-errors.adoc b/modules/ROOT/pages/errors/gql-errors.adoc
@@ -7,6 +7,12 @@
 The following page provides an overview of all GQLSTATUS server error codes in Neo4j.
 All errors in Neo4j have severity level `ERROR`.
 
+[WARNING]
+====
+Please note that while GQLSTATUS codes remain stable, the status descriptions associated with these codes may change over time.
+For this reason, parsing the status descriptions or incorporating them into scripts is not recommended.
+====
+
 == Connection exceptions
 
 Connection exceptions occur when the client (e.g. Browser/Bloom/Cypher Shell) is unable to connect to the server for various reasons such as network issues, server-side routing being disabled, or the database being unavailable, etc.

diff --git a/modules/ROOT/pages/notifications/all-notifications.adoc b/modules/ROOT/pages/notifications/all-notifications.adoc
@@ -15,6 +15,11 @@ The following page provides an overview of all notifications in Neo4j, including
 * <<_schema_notifications, `SCHEMA` notifications>>
 * <<_generic, `GENERIC` notifications>>
 
+[WARNING]
+====
+Please note that while GQLSTATUS codes remain stable, the status descriptions associated with these codes may change over time.
+For this reason, parsing the status descriptions or incorporating them into scripts is not recommended.
+====
 
 [#_performance_notifications]
 == `PERFORMANCE` notifications