Skip to content

Commit 02b5dd4

Browse files
Apply suggestions from code review
Co-authored-by: Richard Sill <[email protected]>
1 parent 5785102 commit 02b5dd4

File tree

2 files changed

+62
-45
lines changed

2 files changed

+62
-45
lines changed

modules/ROOT/pages/aura-graphql-data-apis/index.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
= GraphQL for Neo4j AuraDB Beta
22

3-
== Foreword
4-
5-
Welcome to the beta release of *GraphQL for Neo4j AuraDB*.
3+
Welcome to the beta release of GraphQL for Neo4j AuraDB.
64

75
We are thrilled to have you join us at this exciting stage of our journey. Participating is more than just trying out this feature – your feedback and insights will directly influence how we refine and evolve its future to meet the needs of users like you.
86

@@ -12,7 +10,7 @@ Here’s how you can help us get *GraphQL for Neo4j AuraDB* ready for production
1210

1311
- *Dive in*: Explore and test its features to your heart’s content.
1412
- *Break stuff*: We’d rather discover weak areas at this stage – go for it, don’t hold back.
15-
- *Share your experience*: Tell us what works, what doesnt, and what youd like to see in the future.
13+
- *Share your experience*: Tell us what works, what doesn't, and what you'd like to see in the future.
1614
- *Stay in touch*: Use email (`[email protected]`), our `#graphql` channel on our https://discord.gg/M8mTADEJ[Discord Community], or our https://community.neo4j.com/c/drivers-stacks/graphql/33[forums] to report issues, suggest improvements, or ask questions.
1715
1816
We value your time, creativity, and honest feedback – thank you for your trust and collaboration.

modules/ROOT/pages/aura-graphql-data-apis/prerequisites.adoc

Lines changed: 60 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -4,66 +4,70 @@ Management of the beta of GraphQL for Neo4j AuraDB is performed using the Aura C
44

55
== Read This Before You Start
66

7-
Using the GraphQL API during the Open Beta will be at no cost to you. Usage of the associated AuraDB instance will be charged as normal unless you’re using Aura Pro Trials which, as the name suggests, is a zero-cost option.
7+
Using the GraphQL API during the Open Beta is free of charge.
8+
Usage of the associated AuraDB instance will be charged as normal unless you're using Aura Pro Trials which is a zero-cost option.
89

9-
At the end of the beta period, all running GraphQL endpoints will be terminated and destroyed in preparation for the full release. Notification of this will be sent out two weeks before GraphQL endpoints are withdrawn.
10+
At the end of the beta period, all running GraphQL endpoints will be terminated in preparation for the full release.
11+
We will send out a notification two weeks before they are terminated.
1012

1113

12-
== Obtain Aura API Credentials
14+
== Obtain Aura API credentials
1315

14-
The Aura CLI communicates with Neo4j AuraDB platform by use of an API. To use the API, a set of credentials is required. To get the credentials, follow these steps depending on which version of the console you are using.
16+
The Aura CLI communicates with Neo4j AuraDB platform via an API.
17+
To use the API, a set of credentials is required.
18+
To get the credentials, follow these steps depending on which version of the console you are using.
1519

16-
=== New Unified Aura Console Experience
20+
=== New unified Aura Console experience
1721

18-
1. Login into the https://console.neo4j.io/[Neo4j Aura Console]
19-
2. Navigate to the top right where your account name is displayed as shown in the red box below and click on the down arrow:
22+
1. Log in to the link:https://console.neo4j.io/[Neo4j Aura Console].
23+
2. Navigate to the top right where your account name is displayed and click the down arrow.
2024
+
2125
image::aura-graphql-data-apis/unified-console-home.png[]
2226
+
23-
3. From the menu, choose API keys:
27+
3. In the menu, click *API keys*.
2428
+
2529
image::aura-graphql-data-apis/unified-console-account-dropdown.png[]
2630
+
27-
4. Select Create:
31+
4. Click *Create*.
2832
+
2933
image::aura-graphql-data-apis/unified-console-api-keys.png[]
3034
+
31-
5. On the pop-up window, enter a name for the API Key and then select Create:
35+
5. In the pop-up window, enter a name for the API Key and click *Create*.
3236
+
3337
image::aura-graphql-data-apis/unified-console-create-api-key.png[]
3438
+
35-
6. You will be shown the client id and client secret. Make a note as the client secret will not be shown again and you need both. If you download them, keep them safe
39+
6. The client ID and client secret are displayed. Make a note as the client secret will not be shown again and you need both. If you download them, keep them safe.
3640

37-
=== Aura Console Classic
41+
=== Aura Console classic
3842

39-
1. Login into the https://console.neo4j.io/[Neo4j Aura Console]
40-
2. Navigate to the top right where your account name is displayed as shown in the red box below and click on the down arrow:
43+
1. Log in to the link:https://console.neo4j.io/[Neo4j Aura Console].
44+
2. Navigate to the top right where your account name is displayed and click the down arrow.
4145
+
4246
image::aura-graphql-data-apis/console-classic-home.png[]
4347
+
44-
3. You will be shown a menu with your account name. Select Account Details
45-
4. From the Account Details display, select the Create button in the Aura API Credentials section:
48+
3. A menu with your account name is displayed. Click *Account Details*.
49+
4. In the *Account Details* menu, click *Create* in the *Aura API* credentials section.
4650
+
4751
image::aura-graphql-data-apis/console-classic-api-keys.png[]
4852
+
49-
5. On the pop-up window, enter a Client name, and select Create
50-
6. You will be shown the newly created Client ID and Client Secret. Make sure to securely save these as they are required to use the Aura CLI
53+
5. In the pop-up window, enter a client name and click *Create*.
54+
6. The newly created client ID and client secret are displayed. Make sure to securely save these as they are required to use the Aura CLI.
5155

52-
== Install & Configure the Aura CLI
56+
== Install and configure the Aura CLI
5357

5458
=== Installation
5559

56-
. Using your browser, navigate to https://github.com/neo4j/aura-cli/releases/tag/v1.1.0
60+
. Navigate to link:https://github.com/neo4j/aura-cli/releases/tag/v1.1.0[https://github.com/neo4j/aura-cli/releases/tag/v1.1.0] in your browser.
5761
+
5862
[NOTE]
5963
====
60-
We advise using at least version 1.1.0 for managing your GraphQL APIs
64+
Use Aura CLI version 1.1.0 or higher for managing your GraphQL APIs.
6165
====
6266
+
63-
. Download the compressed file that matches your computer. Make a note of the folder where the file is located
64-
. After the file has been downloaded, extract the contents
65-
. Open a command prompt and move to the location where you extracted the files
66-
. Complete the installation by moving the aura-cli executable file into the file path
67+
. Download the compressed file that matches your system. Make a note of the folder where the file is located.
68+
. After the file has been downloaded, extract the contents.
69+
. Open a command prompt and move to the location where you extracted the files.
70+
. Complete the installation by moving the aura-cli executable file into the file path.
6771
.. Mac/Linux users:
6872
+
6973
[source, bash, indent=0]
@@ -94,12 +98,17 @@ aura version v1.1.0
9498

9599
[NOTE]
96100
====
97-
If you are using a Mac, you may receive a rather alarming warning from Apple that aura-cli could not be verified. If this happens, then open *system settings*, select *Privacy & Security* on the left, and scroll down on the right. Select *Open Anyway*. This should not happen again. The aura-cli has been through the Apple certification process but this can take time to trickle down through the Apple ecosystem.
101+
If you are using a Mac, you may receive a warning from Apple that aura-cli could not be verified.
102+
If this happens, open *System Settings*, click *Privacy & Security* on the left, and scroll down on the right.
103+
Click *Open Anyway*.
104+
This should not happen again.
105+
The aura-cli has been through the Apple certification process but it can take time to trickle down through the Apple ecosystem.
98106
====
99107

100-
=== Add Aura API Credentials
108+
=== Add Aura API credentials
101109

102-
Configure the Aura CLI with the Aura API client ID and client secret you obtained earlier. The Aura CLI refers to these as credentials and it is possible to have several sets of credentials and then choose which one to use.
110+
Configure the Aura CLI with the Aura API client ID and client secret you obtained earlier.
111+
The Aura CLI refers to these as credentials and it is possible to have several sets of credentials and then choose which one to use.
103112

104113
. At the command prompt, enter the following, using your values for the items in CAPITALS:
105114
+
@@ -116,9 +125,10 @@ aura-cli instance list --output table
116125
----
117126

118127

119-
=== Set the Beta Flag
128+
=== Set the beta flag
120129

121-
Instruct the Aura CLI to make available the commands for the open beta. This requires setting a configuration option.
130+
Instruct the Aura CLI to make available the commands for the open beta.
131+
This requires setting a configuration option.
122132

123133
. At the command prompt, enter the following:
124134
+
@@ -127,7 +137,7 @@ Instruct the Aura CLI to make available the commands for the open beta. This req
127137
aura-cli config set beta-enabled true
128138
----
129139
+
130-
. Check commands are listed for the open beta:
140+
. Check if the commands are listed for the open beta:
131141
+
132142
[source, bash, indent=0]
133143
----
@@ -165,25 +175,32 @@ Global Flags:
165175
Use "aura-cli data-api graphql [command] --help" for more information about a command.
166176
----
167177

168-
== Author GraphQL Type Definitions
178+
== Write GraphQL type definitions
169179

170-
Before you create a GraphQL API for use with an Aura instance, you must have type definitions ready for use.
180+
Before you create a GraphQL API for use with an Aura instance, you must create type definitions.
171181

172-
If you already have type definitions from an existing GraphQL implementation these can be used but some exceptions need to be dealt with as these are not currently supported.
182+
If you already have type definitions from an existing GraphQL implementation these can be used.
183+
However, you must deal with some exceptions.
184+
The following are not currently supported:
173185

174-
* The `@customResolver`/`@populatedBy` directives
186+
* The `@customResolver` and `@populatedBy` directives
175187
* Subscriptions
176188

177-
Using the https://graphql-toolbox.neo4j.io/[Neo4j GraphQL Toolbox] is an easy way to produce and try out type definitions. Use of the Toolbox requires a connection to your Aura instance.
189+
Using the link:https://graphql-toolbox.neo4j.io/[Neo4j GraphQL Toolbox] is an easy way to produce and try out type definitions.
190+
Use of the Toolbox requires a connection to your Aura instance.
178191

179192
[NOTE]
180193
====
181-
The *Neo4j GraphQL Toolbox* currently, supports version 6 of the `@neo4j/graphql` library. However, GraphQL APIs run the version 7 alpha. As a result, type definitions created via the toolbox may not be valid with a GraphQL API. You can find a list of the breaking changes https://github.com/neo4j/graphql/releases?q=%40neo4j%2Fgraphql%407.0.0-alpha&expanded=true[here].
194+
The *Neo4j GraphQL Toolbox* currently,supports version 6 of the `@neo4j/graphql` library.
195+
However, GraphQL APIs run the version 7 alpha.
196+
As a result, type definitions created via the toolbox may not be valid with a GraphQL API.
197+
You can find a list of the breaking changes link:https://github.com/neo4j/graphql/releases?q=%40neo4j%2Fgraphql%407.0.0-alpha&expanded=true[here].
182198
====
183199

184-
When your type definitions are ready, save them to a file. They will be used with the Aura CLI to create the GraphQL API.
200+
When your type definitions are ready, save them to a file.
201+
They will be used with the Aura CLI to create the GraphQL API.
185202

186-
== Select the AuraDB Instance To Use
203+
== Select the AuraDB instance
187204

188205
At the command prompt, type:
189206

@@ -192,6 +209,8 @@ At the command prompt, type:
192209
aura-cli instance list
193210
----
194211

195-
Your AuraDB instances will be displayed along with their IDs. Make a note of the ID for the AuraDB instance that you will use with the GraphQL API.
212+
Your AuraDB instances are displayed along with their IDs.
213+
Make a note of the ID of the AuraDB instance that you will use with the GraphQL API.
196214

197-
After choosing an AuraDB to use and obtaining it’s ID, you must also have its username and password to use for authentication. For AuraDB, the username will likely be neo4j and the password would have been shown when it was created. If you do not have this information you cannot proceed with this instance.
215+
After choosing an AuraDB to use and obtaining its ID, you must also have its username and password to use for authentication.
216+
For AuraDB, the username will likely be "neo4j" and the password has been shown when it was created.

0 commit comments

Comments
 (0)