2.0.0 documentation updates

docs/antora/content-nav.adoc

@@ -1,50 +1,64 @@
 * xref:index.adoc[]
+** xref:introduction/index.adoc[]
 ** xref:getting-started/index.adoc[]
 ** xref:type-definitions/index.adoc[]
+*** xref:type-definitions/basics/index.adoc[]
 *** xref:type-definitions/types/index.adoc[]
 *** xref:type-definitions/unions-and-interfaces/index.adoc[]
 *** xref:type-definitions/relationships/index.adoc[]
 *** xref:type-definitions/access-control/index.adoc[]
 *** xref:type-definitions/autogeneration/index.adoc[]
 *** xref:type-definitions/cypher/index.adoc[]
 *** xref:type-definitions/default-values/index.adoc[]
-** xref:custom-resolvers/index.adoc[]
-** xref:schema/index.adoc[]
-*** xref:schema/queries/index.adoc[]
-*** xref:schema/mutations/index.adoc[]
-*** xref:schema/filtering/index.adoc[]
-*** xref:schema/sorting/index.adoc[]
-*** xref:schema/pagination/index.adoc[]
 ** xref:queries/index.adoc[]
 ** xref:mutations/index.adoc[]
+*** xref:mutations/create/index.adoc[]
+*** xref:mutations/update/index.adoc[]
+*** xref:mutations/delete/index.adoc[]
+** xref:filtering/index.adoc[]
+** xref:sorting/index.adoc[]
+** xref:pagination/index.adoc[]
+*** xref:pagination/offset-based/index.adoc[]
+*** xref:pagination/cursor-based/index.adoc[]
+** xref:custom-resolvers/index.adoc[]
 ** xref:auth/index.adoc[]
 *** xref:auth/setup/index.adoc[]
+*** xref:auth/auth-directive/index.adoc[]
 *** xref:auth/authentication/index.adoc[]
 *** xref:auth/authorization/index.adoc[]
-**** xref:auth/authorization/roles/index.adoc[]
 **** xref:auth/authorization/allow/index.adoc[]
-**** xref:auth/authorization/where/index.adoc[]
 **** xref:auth/authorization/bind/index.adoc[]
+**** xref:auth/authorization/roles/index.adoc[]
+**** xref:auth/authorization/where/index.adoc[]
 ** xref:directives/index.adoc[]
 ** xref:api-reference/index.adoc[]
+*** xref:api-reference/neo4jgraphql/index.adoc[]
+*** xref:api-reference/ogm/index.adoc[]
 ** xref:ogm/index.adoc[]
-*** xref:ogm/getting-started/index.adoc[]
-*** xref:ogm/methods/index.adoc[]
-**** xref:ogm/methods/create/index.adoc[]
-**** xref:ogm/methods/find/index.adoc[]
-**** xref:ogm/methods/count/index.adoc[]
-**** xref:ogm/methods/update/index.adoc[]
-**** xref:ogm/methods/delete/index.adoc[]
+*** xref:ogm/installation/index.adoc[]
+*** xref:ogm/examples/index.adoc[]
+**** xref:ogm/examples/custom-resolvers/index.adoc[]
+**** xref:ogm/examples/rest-api/index.adoc[]
 *** xref:ogm/private/index.adoc[]
 *** xref:ogm/selection-set/index.adoc[]
 *** xref:ogm/api-reference/index.adoc[]
-** xref:drivers-and-config/index.adoc[]
+**** xref:ogm/api-reference/ogm/index.adoc[]
+**** xref:ogm/api-reference/model/index.adoc[]
+***** xref:ogm/api-reference/model/create/index.adoc[]
+***** xref:ogm/api-reference/model/find/index.adoc[]
+***** xref:ogm/api-reference/model/update/index.adoc[]
+***** xref:ogm/api-reference/model/delete/index.adoc[]
+***** xref:ogm/api-reference/model/count/index.adoc[]
+** xref:driver-configuration/index.adoc[]
 ** xref:guides/index.adoc[]
 *** xref:guides/migration-guide/index.adoc[]
 **** xref:guides/migration-guide/server/index.adoc[]
 **** xref:guides/migration-guide/type-definitions/index.adoc[]
 **** xref:guides/migration-guide/queries/index.adoc[]
 **** xref:guides/migration-guide/mutations/index.adoc[]
-*** xref:guides/rel-migration/index.adoc[]
-**** xref:guides/rel-migration/mutations/index.adoc[]
+*** xref:guides/v2-migration/index.adoc[]
+**** xref:guides/v2-migration/mutations/index.adoc[]
+**** xref:guides/v2-migration/unions/index.adoc[]
+**** xref:guides/v2-migration/miscellaneous/index.adoc[]
 ** xref:troubleshooting/index.adoc[]
+*** xref:troubleshooting/faqs/index.adoc[]

docs/asciidoc/api-reference/index.adoc

@@ -0,0 +1,5 @@
+[[api-reference]]
+= API Reference
+
+- <<api-reference-neo4jgraphql>>
+- <<api-reference-ogm>>

docs/asciidoc/api-reference/neo4jgraphql.adoc

@@ -0,0 +1,194 @@
+[[api-reference-neo4jgraphql]]
+= `Neo4jGraphQL`
+
+== `constructor`
+
+Returns a `Neo4jGraphQL` instance.
+
+Takes an `input` object as a parameter, the supported fields of which are described below.
+
+=== Example
+
+[source, javascript]
+----
+const neoSchema = new Neo4jGraphQL({
+    typeDefs,
+});
+----
+
+[[api-reference-neo4jgraphql-input]]
+=== Input
+
+Accepts all of the options from https://github.com/ardatan/graphql-tools/blob/%40graphql-tools/schema%407.1.5/website/docs/generate-schema.md#makeexecutableschemaoptions[`makeExecutableSchema`], plus the additional arguments below:
+
+|===
+|Name and Type |Description
+
+|`driver` +
+ +
+ Type: https://neo4j.com/docs/javascript-manual/current/[`Driver`]
+|An instance of a Neo4j driver.
+
+|`config` +
+ +
+ Type: `Neo4jGraphQLConfig`
+|Additional Neo4j GraphQL configuration options.
+|===
+
+[[api-reference-neo4jgraphql-input-neo4jgraphqlconfig]]
+==== `Neo4jGraphQLConfig`
+
+|===
+|Name and Type |Description
+
+|`driverConfig` +
+ +
+ Type: <<api-reference-neo4jgraphql-input-neo4jgraphqlconfig-driverconfig>>
+|Additional driver configuration options.
+
+|`enableRegex` +
+ +
+ Type: `boolean`
+|Whether to enable RegEx filters, see <<filtering-regex>> for more information.
+
+|`jwt` +
+ +
+ Type: <<api-reference-neo4jgraphql-input-neo4jgraphqlconfig-neo4jgraphqljwt>>
+|JWT options.
+
+|`queryOptions` +
+ +
+ Type: <<api-reference-neo4jgraphql-input-neo4jgraphqlconfig-cypherqueryoptions>>
+|Cypher query options, see <<troubleshooting-query-tuning>> for more information.
+
+|`skipValidateTypeDefs` +
+ +
+ Type: `boolean`
+|Can be used to disable strict type definition validation if you are encountering unexpected errors.
+|===
+
+[[api-reference-neo4jgraphql-input-neo4jgraphqlconfig-driverconfig]]
+===== `DriverConfig`
+
+|===
+|Name and Type |Description
+
+|`database` +
+ +
+ Type: `string`
+|The name of the database within the DBMS to connect to.
+
+|`bookmarks` +
+ +
+ Type: `string` or `Array<string>`
+|One or more bookmarks to use for the connection.
+|===
+
+[[api-reference-neo4jgraphql-input-neo4jgraphqlconfig-neo4jgraphqljwt]]
+===== `Neo4jGraphQLJWT`
+
+|===
+|Name and Type |Description
+
+|`secret` +
+ +
+ Type: `string`
+|The secret used to encode JWT tokens. +
+ +
+ *Required* unless passing in decoded tokens.
+
+|`noVerify` +
+ +
+ Type: `boolean`
+|Disable verification of JWT signatures, only decode.
+
+|`rolesPath` +
+ +
+ Type: `string`
+|Dot path of location of roles within JWT token.
+|===
+
+[[api-reference-neo4jgraphql-input-neo4jgraphqlconfig-cypherqueryoptions]]
+===== `CypherQueryOptions`
+
+All options are enum types imported from `@neo4j/graphql`, for example:
+
+[source, javascript]
+----
+const { CypherRuntime } = require("@neo4j/graphql");
+----
+
+|===
+|Name and Type |Description
+
+|`runtime` +
+ +
+ Type: `CypherRuntime`
+|Possible options: +
+ +
+ - `CypherRuntime.INTERPRETED` +
+ - `CypherRuntime.SLOTTED` +
+ - `CypherRuntime.PIPELINED`
+
+|`planner` +
+ +
+ Type: `CypherPlanner`
+|Possible options: +
+ +
+ - `CypherPlanner.COST` +
+ - `CypherPlanner.IDP` +
+ - `CypherPlanner.DP`
+
+|`connectComponentsPlanner` +
+ +
+ Type: `CypherConnectComponentsPlanner`
+|Possible options: +
+ +
+ - `CypherConnectComponentsPlanner.GREEDY` +
+ - `CypherConnectComponentsPlanner.IDP`
+
+|`updateStrategy` +
+ +
+ Type: `CypherUpdateStrategy`
+|Possible options: +
+ +
+ - `CypherUpdateStrategy.DEFAULT` +
+ - `CypherUpdateStrategy.EAGER`
+
+|`expressionEngine` +
+ +
+ Type: `CypherExpressionEngine`
+|Possible options: +
+ +
+ - `CypherExpressionEngine.DEFAULT` +
+ - `CypherExpressionEngine.INTERPRETED` +
+ - `CypherExpressionEngine.COMPILED`
+
+|`operatorEngine` +
+ +
+ Type: `CypherOperatorEngine`
+|Possible options: +
+ +
+ - `CypherOperatorEngine.DEFAULT` +
+ - `CypherOperatorEngine.INTERPRETED` +
+ - `CypherOperatorEngine.COMPILED`
+
+|`interpretedPipesFallback` +
+ +
+ Type: `CypherInterpretedPipesFallback`
+|Possible options: +
+ +
+ - `CypherInterpretedPipesFallback.DEFAULT` +
+ - `CypherInterpretedPipesFallback.DISABLED` +
+ - `CypherInterpretedPipesFallback.WHITELISTED_PLANS_ONLY` +
+ - `CypherInterpretedPipesFallback.ALL`
+
+|`replan` +
+ +
+ Type: `CypherReplanning`
+|Possible options: +
+ +
+ - `CypherReplanning.DEFAULT` +
+ - `CypherReplanning.FORCE` +
+ - `CypherReplanning.SKIP`
+|===

docs/asciidoc/api-reference/ogm.adoc

@@ -0,0 +1,4 @@
+[[api-reference-ogm]]
+= `@neo4j/graphql-ogm`
+
+See <<ogm-api-reference-ogm>>.