Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a page for each GQLSTATUS error and update the structure #245

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

renetapopova
Copy link
Collaborator

@renetapopova renetapopova commented Dec 27, 2024

Need to include also the codes from https://github.com/neo4j/docs-status-codes/pull/249/files

@neo-technology-commit-status-publisher
Copy link
Collaborator

This PR includes documentation updates
View the updated docs at https://neo4j-docs-status-codes-245.surge.sh

New pages:

Updated pages:

@Lojjs Lojjs self-assigned this Jan 7, 2025
Copy link
Contributor

@Lojjs Lojjs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work with this massive PR! Most of my comments are small (like copy-paste errors and such), the two bigger ones we can discuss in an upcoming sync

= 22N01

== Status description
error: data exception - invalid type.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
error: data exception - invalid type.
error: data exception - invalid type. Expected the value `{ $value }` to be of type `{ $valueTypeList }`, but was of type `{ $valueType }`.

The message part is missing here

**** xref:errors/gql-errors/22NA8.adoc[]
**** xref:errors/gql-errors/22NB0.adoc[]
**** xref:errors/gql-errors/22NB1.adoc[]
Invalid transaction state
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like both the GQLSTATUS codes starting with 22 and 25 is under ‘Data exceptions’ in the left-hand-side menu. I think it is this line which is missing some stars


* xref:errors/index.adoc[]
** xref:errors/gql-errors/index.adoc[]
*** Connection exceptions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like the left hand side menu with several levels. But when clicking titles in it (e.g. ‘Connection exceptions’) should that only open the sub menu or also take me to the Connection Exception anchor on the index page? 



Also it was slightly annoying that the menu did not center on the page I was on but always scrolled all the way up. Maybe this last thing is not really an issue for real users that do not click on every single link in the menu to verify if they are working, haha.

I can show you more what I mean with this on the docs sync and we can discuss it there, unless you have immediate thoughts.

@@ -17,99 +17,88 @@ For this reason, parsing the status descriptions or incorporating them into scri

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.

=== 08000
=== xref:errors/gql-errors/08000.adoc[08000]

Status description:: error: connection exception
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’m thinking we should maybe not keep the status descriptions on the main page but only use it as a sort of index page. But I am not 100% sure, so maybe we can discuss this in our docs sync.

= 22N98

== Status description
error: data exception - wrong first field during deserialization. Unable to deserialize request. Expected first field to be `{ $field }`, but was '{ $value }'.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
error: data exception - wrong first field during deserialization. Unable to deserialize request. Expected first field to be `{ $field }`, but was '{ $value }'.
error: data exception - wrong first field during deserialization. Unable to deserialize request. Expected first field to be `{ $field }`, but was `{ $value }`.

This was already wrong before the split, but I didn't notice it until now. If we decide to keep the status descriptions in the index file as well, it should be updated in both places.

= 25N04

== Status description
error: invalid transaction state - specified transaction does not exist.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
error: invalid transaction state - specified transaction does not exist.
error: invalid transaction state - specified transaction does not exist. Transaction `{ $transactionId }` does not exist.

This one is missing the message part.

= 42I05

== Status description
error: syntax error or access rule violation - invalid FIELDTERMINATOR. The FIELDTERMINATOR specified for LOAD CSV can only be one character wide. The FIELDTERMINATOR specified for LOAD CSV can only be one character wide.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sentence

The FIELDTERMINATOR specified for LOAD CSV can only be one character wide.

is duplicated by misstake. This was already wrong before the split, but I didn't notice it until now. If we decide to keep the status descriptions in the index file as well, it should be updated in both places.

= 42N29

== Status description
error: syntax error or access rule violation - unbound variables in pattern expression. Pattern expressions are not allowed to introduce new variables: `{ $var }`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
error: syntax error or access rule violation - unbound variables in pattern expression. Pattern expressions are not allowed to introduce new variables: `{ $var }`.
error: syntax error or access rule violation - unbound variables in pattern expression. Pattern expressions are not allowed to introduce new variables: `{ $variable }`.

This was already wrong before the split, but I didn't notice it until now. If we decide to keep the status descriptions in the index file as well, it should be updated in both places.

= 51N14

== Status description
error: system configuration or operation exception - duplicate field name.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
error: system configuration or operation exception - duplicate field name.
error: system configuration or operation exception - duplicate field name. The procedure `{ $proc }` has a duplicate `{ $procFieldType }` field, `{ $procField }`.

This one is also missing its message part

@Lojjs Lojjs mentioned this pull request Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants