From f6e1481903aea17a3741eab4f0d2d183bb429313 Mon Sep 17 00:00:00 2001 From: Darrell Warde Date: Thu, 15 Feb 2024 14:18:38 +0000 Subject: [PATCH 1/3] Add `@jwtClaim` to the directives index --- .../pages/authentication-and-authorization/configuration.adoc | 1 + modules/ROOT/pages/type-definitions/directives/index.adoc | 3 +++ 2 files changed, 4 insertions(+) diff --git a/modules/ROOT/pages/authentication-and-authorization/configuration.adoc b/modules/ROOT/pages/authentication-and-authorization/configuration.adoc index ac285fe2..c392d997 100644 --- a/modules/ROOT/pages/authentication-and-authorization/configuration.adoc +++ b/modules/ROOT/pages/authentication-and-authorization/configuration.adoc @@ -62,6 +62,7 @@ new Neo4jGraphQL({ }); ---- +[[authentication-and-authorization-jwt]] == JWT By default, filtering is available on https://www.rfc-editor.org/rfc/rfc7519#section-4.1[the registered claim names] in the JWT specification. diff --git a/modules/ROOT/pages/type-definitions/directives/index.adoc b/modules/ROOT/pages/type-definitions/directives/index.adoc index 430ad795..d91fa943 100644 --- a/modules/ROOT/pages/type-definitions/directives/index.adoc +++ b/modules/ROOT/pages/type-definitions/directives/index.adoc @@ -39,6 +39,9 @@ of any required fields that is passed as arguments to the custom resolver. | xref::/type-definitions/directives/autogeneration.adoc#type-definitions-autogeneration-id[`@id`] | Marks a field as the unique ID for an object type, and allows for autogeneration of IDs. +| xref::/authentication-and-authorization/configuration.adoc#authentication-and-authorization-jwt[`@jwtClaim`] +| Marks a field as the unique ID for an object type, and allows for autogeneration of IDs. + | xref::/type-definitions/directives/default-values.adoc#type-definitions-default-values-limit[`@limit`] | Used on nodes to inject values into Cypher `LIMIT` clauses. From c3f58108eccb351b96b9705d26c586d646a30fc3 Mon Sep 17 00:00:00 2001 From: Darrell Warde Date: Thu, 15 Feb 2024 14:18:47 +0000 Subject: [PATCH 2/3] Tweaks to the Getting Started guide --- modules/ROOT/pages/getting-started/index.adoc | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/modules/ROOT/pages/getting-started/index.adoc b/modules/ROOT/pages/getting-started/index.adoc index 9af02117..b9e1c89e 100644 --- a/modules/ROOT/pages/getting-started/index.adoc +++ b/modules/ROOT/pages/getting-started/index.adoc @@ -108,12 +108,12 @@ image::neo4j-aura-dashboard.png[width=500] === Using a Neo4j database -For a database located at the default "bolt://localhost:7687" (see more about https://neo4j.com/docs/operations-manual/current/configuration/ports[port configuration]), with the username "neo4j" and the password "password", add the following to the bottom of your `index.js` file: +For a database located at the default "neo4j://localhost:7687" (see more about https://neo4j.com/docs/operations-manual/current/configuration/ports[port configuration]), with the username "neo4j" and the password "password", add the following to the bottom of your `index.js` file: [source, javascript, indent=0] ---- const driver = neo4j.driver( - "bolt://localhost:7687", + "neo4j://localhost:7687", neo4j.auth.basic("username", "password") ); @@ -131,7 +131,6 @@ const server = new ApolloServer({ }); const { url } = await startStandaloneServer(server, { - context: async ({ req }) => ({ req }), listen: { port: 4000 }, }); @@ -179,7 +178,7 @@ const typeDefs = `#graphql `; const driver = neo4j.driver( - "bolt://localhost:7687", + "neo4j://localhost:7687", neo4j.auth.basic("username", "password") ); From fca58169db2694b08c9ba94d4aac2963ad3b09eb Mon Sep 17 00:00:00 2001 From: Darrell Warde Date: Thu, 15 Feb 2024 14:18:55 +0000 Subject: [PATCH 3/3] Remove dead links from the OGM reference --- modules/ROOT/pages/ogm/reference.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/ogm/reference.adoc b/modules/ROOT/pages/ogm/reference.adoc index a2abb868..4c0df3ea 100644 --- a/modules/ROOT/pages/ogm/reference.adoc +++ b/modules/ROOT/pages/ogm/reference.adoc @@ -16,7 +16,7 @@ The following sections work as a reference guide to all functionalities in OGM a |`constructor` |Returns an `OGM` instance. -Takes an `input` object as a parameter, which is then passed to the `Neo4jGraphQL` constructor. Supported options are listed in the documentation for xref::reference/api-reference/neo4jgraphql.adoc[`Neo4jGraphQL`]. +Takes an `input` object as a parameter, which is then passed to the `Neo4jGraphQL` constructor. a| [source, javascript, indent=0] ---- @@ -27,7 +27,7 @@ const ogm = new OGM({ |`init` |Asynchronous method to initialize the OGM. -Internally, calls xref::reference/api-reference/neo4jgraphql.adoc#api-reference-getschema[`Neo4jGraphQL.getSchema()`] to generate a GraphQL schema, and stores the result. +Internally, calls `Neo4jGraphQL.getSchema()` to generate a GraphQL schema, and stores the result. Initializes any models which have been created before this execution, and will throw an error if any of them are invalid. a| [source, javascript, indent=0]