Skip to content

Commit 5e5be2e

Browse files
committed
Consistent naming
1 parent 26493ec commit 5e5be2e

File tree

4 files changed

+33
-33
lines changed

4 files changed

+33
-33
lines changed

modules/ROOT/pages/aura-graphql-data-apis/authentication-providers.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ There are advantages and disadvantages of both types. API keys are quick to star
77

88
[NOTE]
99
====
10-
`--data-api-id` is used with the `aura-cli` when working with authentication providers rather than `--graphql-api-id` as you might have expected. Conceptually a graphql api is a type of data api and there may be other types in the future. Using `--data-api-id` allows for flexibility for potential future development work in this area.
10+
`--data-api-id` is used with the `aura-cli` when working with authentication providers rather than `--graphql-api-id` as you might have expected. Conceptually a GraphQL API is a type of Data API and there may be other types in the future. Using `--data-api-id` allows for flexibility for potential future development work in this area.
1111
====
1212

1313
== Create a JWKS Authentication Provider
Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
= Deploy and Operate
22

3-
== Deploy a GraphQL Data API
3+
== Deploy a GraphQL API
44

55

6-
Deploying a GraphQL Data API requires you first to have completed the steps in xref::/aura-graphql-data-apis/prerequisites.adoc[Prerequisites]. Of particular importance is that you have:
6+
Deploying a GraphQL API requires you first to have completed the steps in xref::/aura-graphql-data-apis/prerequisites.adoc[Prerequisites]. Of particular importance is that you have:
77

88
* The ID, username and password for the AuraDB
99
* A file containing the type definitions
1010

11-
You are now ready to create the GraphQL Data API with the Aura CLI. Substitute the values in `CAPITALS` to match your setup:
11+
You are now ready to create the GraphQL API with the Aura CLI. Substitute the values in `CAPITALS` to match your setup:
1212

1313
[source, bash, indent=0]
1414
----
15-
aura-cli data-api graphql create --name YOUR-FRIENDLY-NAME --instance-id YOUR-AURA-INSTANCE-ID --instance-username YOUR-AURA-INSTANCE-USER --instance-password YOUR-AURA-INSTANCE-PASSWORD --type-definitions-file
16-
FULL-PATH-TO-YOUR-TYPE-DEFS --await
15+
aura-cli data-api graphql create --name YOUR_FRIENDLY_NAME --instance-id YOUR_AURA_INSTANCE_ID --instance-username YOUR_AURA_INSTANCE_USER --instance-password YOUR_AURA_INSTANCE_PASSWORD --type-definitions-file
16+
FULL_PATH_TO_YOUR_TYPE_DEFS --await
1717
----
1818

1919
[NOTE]
@@ -23,51 +23,51 @@ Make sure to record the API key shown in the response as it will not be displaye
2323

2424
There are other items of note in the response:
2525

26-
* `id`: unique identifier for the GraphQL Data API
27-
* `status`: tells you if the GraphQL Data API is ready to receive requests
28-
* `url`: the connection address to access the Data API
26+
* `id`: unique identifier for the GraphQL API
27+
* `status`: tells you if the GraphQL API is ready to receive requests
28+
* `url`: the connection address to access the GraphQL API
2929

30-
To check if the GraphQL Data API is ready for requests, use the Aura CLI again, changing `YOUR-AURA-INSTANCE-ID` for the ID of your aura instance.
30+
To check if the GraphQL API is ready for requests, use the Aura CLI again, changing `YOUR_AURA_INSTANCE_ID` for the ID of your aura instance.
3131

3232
[source, bash, indent=0]
3333
----
34-
aura-cli data-api graphql list --instance-id YOUR-AURA-INSTANCE-ID
34+
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID
3535
----
3636

37-
When the status changes to `ready`, the GraphQL Data API is available for servicing requests.
37+
When the status changes to `ready`, the GraphQL API is available for servicing requests.
3838

39-
== Modifying an Existing GraphQL Data API
39+
== Modifying an Existing GraphQL API
4040

41-
It is possible to change the configuration of an existing GraphQL Data API. The following properties can be modified:
41+
It is possible to change the configuration of an existing GraphQL API. The following properties can be modified:
4242

43-
* Friendly name of the GraphQL Data API
43+
* Friendly name of the GraphQL API
4444
* Username and/or password for the associated Aura instance
4545
* Type definitions
4646

47-
To do this, use the Aura CLI update command which requires IDs of the GraphQL Data API and it’s linked AuraDB instance. The format of this Aura CLI command is as follows:
47+
To do this, use the Aura CLI update command which requires IDs of the GraphQL API and it’s linked AuraDB instance. The format of this Aura CLI command is as follows:
4848

4949
[source, bash, indent=0]
5050
----
51-
aura-cli data-api graphql update YOUR-DATA-API-ID --instance-id YOUR-AURA-INSTANCE-ID <flags>
51+
aura-cli data-api graphql update YOUR_GRAPHQL_API_ID --instance-id YOUR_AURA_INSTANCE_ID <flags>
5252
----
5353

54-
As the change takes a few moments to fully implement, you should check the status of the GraphQL Data API after performing this operation; if the status is `updating` then the change is still being processed. When the change is committed, the status will return to `ready`.
54+
As the change takes a few moments to fully implement, you should check the status of the GraphQL API after performing this operation; if the status is `updating` then the change is still being processed. When the change is committed, the status will return to `ready`.
5555

5656

57-
Additionally, it is possible to modify the authentication providers of a GraphQL Data APIs. More on what these are and how to do this xref::/aura-graphql-data-apis/authentication-providers.adoc[here].
57+
Additionally, it is possible to modify the authentication providers of GraphQL APIs. More on what these are and how to do this xref::/aura-graphql-data-apis/authentication-providers.adoc[here].
5858

59-
== Deleting a GraphQL Data API
59+
== Deleting a GraphQL API
6060

61-
When you no longer require the GraphQL Data API then delete it by using the Aura CLI delete command. This will require the Aura instance ID and ID of the GraphQL Data API.
61+
When you no longer require the GraphQL API then delete it by using the Aura CLI delete command. This will require the Aura instance ID and ID of the GraphQL API.
6262

6363
The format of this command is as follows:
6464

6565
[source, bash, indent=0]
6666
----
67-
aura-cli data-api graphql delete YOUR-DATA-API-ID --instance-id YOUR-AURA-INSTANCE-ID
67+
aura-cli data-api graphql delete YOUR_GRAPHQL_API_ID --instance-id YOUR_AURA_INSTANCE_ID
6868
----
6969

7070
[NOTE]
7171
====
72-
There is no additional confirmation - the GraphQL Data API will start to be deleted as soon as you press the Enter key!
72+
There is no additional confirmation - the GraphQL API will start to be deleted as soon as you press the Enter key!
7373
====

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
== Foreword
44

5-
Welcome to the beta release of *GraphQL Data APIs for Neo4j AuraDB*.
5+
Welcome to the beta release of *GraphQL for Neo4j AuraDB*.
66

77
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.
88

9-
This beta release is designed to give you a first look at *GraphQL Data APIs for Neo4j AuraDB*. While we’ve worked hard to ensure a functional and valuable experience, there is the chance that you may encounter suboptimal behavior. We see these occasions as chances to listen, learn, and improve before *GraphQL for Neo4j AuraDB* is released to all of our customers.
9+
This beta release is designed to give you a first look at *GraphQL for Neo4j AuraDB*. While we’ve worked hard to ensure a functional and valuable experience, there is the chance that you may encounter suboptimal behavior. We see these occasions as chances to listen, learn, and improve before *GraphQL for Neo4j AuraDB* is released to all of our customers.
1010

11-
Here’s how you can help us get *GraphQL Data APIs for Neo4j AuraDB* ready for production:
11+
Here’s how you can help us get *GraphQL for Neo4j AuraDB* ready for production:
1212

1313
- *Dive in*: Explore and test its features to your heart’s content.
1414
- *Break stuff*: We’d rather discover weak areas at this stage – go for it, don’t hold back.

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ 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 Data 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 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.
88

99
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.
1010

@@ -57,7 +57,7 @@ image::aura-graphql-data-apis/console-classic-api-keys.png[]
5757
+
5858
[NOTE]
5959
====
60-
We advise using at least version 1.1.0 for managing your GraphQL Data APIs
60+
We advise using at least version 1.1.0 for managing your GraphQL APIs
6161
====
6262
+
6363
. Download the compressed file that matches your computer. Make a note of the folder where the file is located
@@ -138,7 +138,7 @@ aura-cli data-api graphql
138138
+
139139
[source, bash, indent=0]
140140
----
141-
Allows you to programmatically provision and manage your GraphQL Data APIs
141+
Allows you to programmatically provision and manage your GraphQL APIs
142142
143143
Usage:
144144
aura-cli data-api graphql [command]
@@ -167,7 +167,7 @@ Use "aura-cli data-api graphql [command] --help" for more information about a co
167167

168168
== Author GraphQL Type Definitions
169169

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

172172
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.
173173

@@ -178,10 +178,10 @@ Using the https://graphql-toolbox.neo4j.io/[Neo4j GraphQL Toolbox] is an easy wa
178178

179179
[NOTE]
180180
====
181-
The *Neo4j GraphQL Toolbox* currently, supports version 6 of the `@neo4j/graphql` library. However, GraphQL Data APIs run the version 7 alpha. As a result, type definitions created via the toolbox may not be valid with a GraphQL Data 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].
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].
182182
====
183183

184-
When your type definitions are ready, save them to a file. They will be used with the Aura CLI to create the GraphQL Data API.
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.
185185

186186
== Select the AuraDB Instance To Use
187187

@@ -192,6 +192,6 @@ At the command prompt, type:
192192
aura-cli instance list
193193
----
194194

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 Data API.
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.
196196

197197
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.

0 commit comments

Comments
 (0)