Skip to content

Commit 029ae62

Browse files
Apply suggestions from code review
Co-authored-by: Richard Sill <156673635+rsill-neo4j@users.noreply.github.com>
1 parent 7d1cb9d commit 029ae62

File tree

1 file changed

+35
-41
lines changed

1 file changed

+35
-41
lines changed

modules/ROOT/pages/aura-graphql/ending-with-the-beta.adoc

Lines changed: 35 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,86 @@
1-
= Ending with the Beta
1+
= End of beta phase
22

3-
On the 18th April the Beta will end. If you have already achieved what you set out to do or will be wrapping up before that date, there are three steps that we suggest you take
3+
The beta phase of GraphQL for Neo4j AuraDB will end on the 18th of April 2025.
4+
To prevent data loss and wrap up your beta experience we suggest you take the following steps:
45

56
* Backup GraphQL Data API configuration
67
* Remove the GraphQL Data API
78
* Provide feedback
89
9-
Doing nothing is an option although you need to be aware that any running GraphQL Data API after the 18th April will be terminated resulting in the loss of it configuration information including Type Definitions. You strongly advised to take action before that time.
10+
You are not required to take action.
11+
However, any running GraphQL Data API will be terminated after the 18th of April, resulting in the loss of its configuration information including type definitions.
1012

1113

1214
== Backup the GraphQL Data API configuration
1315

14-
Saving your GraphQL Data API configuration makes re-use much quicker if you decide to use this feature once it is released fully. If you don't want to do that and want to run your own GraphQL service, part of the retreived information includes the Type Definitions that can be used for that purpose
16+
Backing up your GraphQL Data API configuration makes re-use much quicker if you decide to use this feature once it is released.
17+
If you want to run your own GraphQL service instead, the backup might still be useful since it includes the type definitions which can be used for that purpose.
1518

16-
There are two ways to perform a backup
19+
There are two ways to perform a backup:
1720

18-
* Manually copy them one by one from the Console
19-
* Using the Aura CLI to obtain everything in one operation
21+
* Manually copy them one by one from the Aura Console
22+
* Using the Aura CLI to obtain everything in a single operation
2023

2124

2225
=== Console
23-
If you want to retain only parts of the configuration, this is a fairly quick method to do so. If you are intent on backing up all of the configuration is it recommended to use the Aura CLI
2426

25-
1. After entering the Console, select *Data API* from the left hand navigation bar
27+
If you want to retain only parts of the configuration, this is a quick method to do so.
28+
If you are intent on backing up all of the configuration, use the xref:#_aura_cli[] instead.
29+
30+
1. On Aura Console, select **Data API** from the left side navigation.
2631
+
2732
image::aura-graphql/console_data_api_sidebar.png[]
2833
+
29-
30-
2. A table will be shown that contains your GraphQL Data APIs. On the row with the GraphQL Data API that you wish to backup, click image:aura-graphql/three-dots.png[] and, from the menu, choose *Edit*
34+
2. The table shows your GraphQL Data APIs. Use the three dots on the row with the GraphQL Data API that you wish to backup and select **Edit**.
3135
+
3236
image::aura-graphql/console_data_api_edit_menu.png[]
3337
+
34-
35-
3. Expand each of the sections and then make a note of the setting or copy as necessary
38+
3. Expand each of the sections and then make a note of the setting or copy as necessary.
3639
+
3740
image::aura-graphql/console_data_api_edit.png[]
38-
+
39-
4. When you are finished, select *Back*
4041

4142

4243
=== Aura CLI
4344

44-
It is assumed that you have already configured the Aura CLI. If you have not, follow the guidance provided in xref:aura-graphql/prerequisites.adoc#_install_and_configure_the_aura_cli[`Install and configure the Aura CLI`]
45+
This section assumes that you have configured the Aura CLI.
46+
If you have not, follow the guidance provided in xref:aura-graphql/prerequisites.adoc#_install_and_configure_the_aura_cli[].
4547

4648

47-
1. Lookup the Aura instance ID that the GraphQL API is being used with
49+
1. Look up the Aura instance ID that the GraphQL API is being used with.
4850
+
4951
[source, bash, indent=0]
5052
----
5153
aura-cli instance list --output table
5254
----
5355
+
5456

55-
2. From the displayed table, make a note of relevant Aura ID. This ID will then be used to obtain the ID of the GraphQL API whose configuration will be backed up.
57+
2. From the displayed table, make a note of relevant Aura ID. Use this ID to obtain the ID of the GraphQL API whose configuration you want to back up.
5658
+
5759
[source, bash, indent=0]
5860
----
5961
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table
6062
----
6163
+
6264

63-
3. Finally, obtain the configuration of the GraphQL API itself that will be shown to you in the form of a JSON document.
65+
3. Finally, obtain the configuration of the GraphQL API itself in JSON format.
6466
+
6567
[source, bash, indent=0]
6668
----
6769
aura-cli data-api graphql get YOUR_GRAPHQL_DATA_API_ID --instance-id YOUR_AURA_INSTANCE_ID
6870
----
6971
+
70-
71-
4. Save the output to safe location for any future use.
72+
4. Save the output for future use.
7273

7374
[NOTE]
7475
====
75-
Type Definitions are stored using Base64 encoding. You will need to decode them back to plain text before using with other systems.
76+
Type definitions are stored using Base64 encoding.
77+
Decode them to plain text before using with other systems.
7678
====
7779

7880

7981
== Removing the GraphQL Data API
80-
This can be performed using the Console or with the Aura CLI. Both methods are described below
82+
83+
Remove the GraphQL Data API either via Aura Console or with the Aura CLI.
8184

8285
[WARNING]
8386
====
@@ -86,28 +89,24 @@ Once the GraphQL Data API has been deleted, it cannot be recovered.
8689

8790

8891
=== Console
89-
1. After entering the Console, select *Data API* from the left hand navigation bar
92+
93+
1. In Aura Console, select **Data API** from the left side navigation.
9094
+
9195
image::aura-graphql/console_data_api_sidebar.png[]
9296
+
93-
94-
2. A table will be shown that contains your GraphQL Data APIs. On the row with the GraphQL Data API that you wish to remove, click image:aura-graphql/three-dots.png[] and, from the menu, choose *Delete*
95-
97+
2. The table contains your GraphQL Data APIs. Use the three dots on the row with the GraphQL Data API that you wish to remove and select **Delete**.
9698
+
9799
image::aura-graphql/console_data_api_delete_menu.png[]
98100
+
99-
100-
3. Type in the name of your GraphQL API and then click *Delete*
101+
3. Type in the name of your GraphQL API and confirm with **Delete**.
101102
+
102103
image::aura-graphql/console_data_api_confirm_delete_menu.png[]
103-
+
104-
105-
4. The GraphQL API will now be deleted.
106-
107104

108105

109106
=== Aura CLI
110-
It is assumed that you have already configured the Aura CLI. If you have not, follow the guidance provided in xref:aura-graphql/prerequisites.adoc#_install_and_configure_the_aura_cli[`Install and configure the Aura CLI`]
107+
108+
This section assumes that you have configured the Aura CLI.
109+
If you have not, follow the guidance provided in xref:aura-graphql/prerequisites.adoc#_install_and_configure_the_aura_cli[].
111110

112111
1. Locate the Aura instance ID that the GraphQL API is being used with.
113112
+
@@ -116,29 +115,24 @@ It is assumed that you have already configured the Aura CLI. If you have not, f
116115
aura-cli instance list --output table
117116
----
118117
+
119-
120-
2. From the displayed table, make a note of relevant Aura ID. This ID will then be used to obtain the ID of the GraphQL API whose configuration will be backed up.
118+
2. From the displayed table, make a note of the relevant Aura ID. Use the ID to obtain the ID of the GraphQL API whose configuration you want to back up.
121119
+
122120
[source, bash, indent=0]
123121
----
124122
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table
125123
----
126124
+
127-
128125
3. Delete the GraphQL API.
129126
+
130127
[WARNING]
131128
====
132-
The Aura CLI does not ask for confirmation and processes the commmand immediately.
129+
The Aura CLI does not ask for confirmation and processes the command immediately.
133130
====
134131
+
135132
[source, bash, indent=0]
136133
----
137134
aura-cli data-api graphql delete YOUR_GRAPHQL_DATA_API_ID --instance-id YOUR_AURA_INSTANCE_ID --output table
138135
----
139-
+
140-
4. The GraphQL API is now deleted
141-
142136

143137

144138
== Provide feedback

0 commit comments

Comments
 (0)