Skip to content

Commit 7d1cb9d

Browse files
LackOfMoralsLackOfMorals
committed
Added page for ending the beta
1 parent 18edfb3 commit 7d1cb9d

9 files changed

+178
-1
lines changed

‎.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,7 @@ target/
3636

3737
# node modules
3838
node_modules/
39-
.env
39+
.env
40+
41+
package-lock.json
42+
yarn.lock

‎modules/ROOT/content-nav.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@
6161
** xref:aura-graphql/deploy-and-operate.adoc[]
6262
** xref:aura-graphql/authentication-providers.adoc[]
6363
** xref:aura-graphql/using-your-api.adoc[]
64+
** xref:aura-graphql/ending-with-the-beta.adoc[]
65+
6466
6567
* xref:introspector.adoc[Introspector]
6668

‎modules/ROOT/images/aura-graphql/console_data_api_confirm_delete_menu.png

668 KB
Loading

‎modules/ROOT/images/aura-graphql/console_data_api_delete_menu.png

631 KB
Loading

‎modules/ROOT/images/aura-graphql/console_data_api_edit.png

646 KB
Loading

‎modules/ROOT/images/aura-graphql/console_data_api_edit_menu.png

630 KB
Loading

‎modules/ROOT/images/aura-graphql/console_data_api_sidebar.png

584 KB
Loading

‎modules/ROOT/images/aura-graphql/three-dots.png

2.13 KB
Loading

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

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
= Ending with the Beta
2+
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
4+
5+
* Backup GraphQL Data API configuration
6+
* Remove the GraphQL Data API
7+
* Provide feedback
8+
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+
11+
12+
== Backup the GraphQL Data API configuration
13+
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
15+
16+
There are two ways to perform a backup
17+
18+
* Manually copy them one by one from the Console
19+
* Using the Aura CLI to obtain everything in one operation
20+
21+
22+
=== 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
24+
25+
1. After entering the Console, select *Data API* from the left hand navigation bar
26+
+
27+
image::aura-graphql/console_data_api_sidebar.png[]
28+
+
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*
31+
+
32+
image::aura-graphql/console_data_api_edit_menu.png[]
33+
+
34+
35+
3. Expand each of the sections and then make a note of the setting or copy as necessary
36+
+
37+
image::aura-graphql/console_data_api_edit.png[]
38+
+
39+
4. When you are finished, select *Back*
40+
41+
42+
=== Aura CLI
43+
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+
46+
47+
1. Lookup the Aura instance ID that the GraphQL API is being used with
48+
+
49+
[source, bash, indent=0]
50+
----
51+
aura-cli instance list --output table
52+
----
53+
+
54+
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.
56+
+
57+
[source, bash, indent=0]
58+
----
59+
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table
60+
----
61+
+
62+
63+
3. Finally, obtain the configuration of the GraphQL API itself that will be shown to you in the form of a JSON document.
64+
+
65+
[source, bash, indent=0]
66+
----
67+
aura-cli data-api graphql get YOUR_GRAPHQL_DATA_API_ID --instance-id YOUR_AURA_INSTANCE_ID
68+
----
69+
+
70+
71+
4. Save the output to safe location for any future use.
72+
73+
[NOTE]
74+
====
75+
Type Definitions are stored using Base64 encoding. You will need to decode them back to plain text before using with other systems.
76+
====
77+
78+
79+
== Removing the GraphQL Data API
80+
This can be performed using the Console or with the Aura CLI. Both methods are described below
81+
82+
[WARNING]
83+
====
84+
Once the GraphQL Data API has been deleted, it cannot be recovered.
85+
====
86+
87+
88+
=== Console
89+
1. After entering the Console, select *Data API* from the left hand navigation bar
90+
+
91+
image::aura-graphql/console_data_api_sidebar.png[]
92+
+
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+
96+
+
97+
image::aura-graphql/console_data_api_delete_menu.png[]
98+
+
99+
100+
3. Type in the name of your GraphQL API and then click *Delete*
101+
+
102+
image::aura-graphql/console_data_api_confirm_delete_menu.png[]
103+
+
104+
105+
4. The GraphQL API will now be deleted.
106+
107+
108+
109+
=== 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`]
111+
112+
1. Locate the Aura instance ID that the GraphQL API is being used with.
113+
+
114+
[source, bash, indent=0]
115+
----
116+
aura-cli instance list --output table
117+
----
118+
+
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.
121+
+
122+
[source, bash, indent=0]
123+
----
124+
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table
125+
----
126+
+
127+
128+
3. Delete the GraphQL API.
129+
+
130+
[WARNING]
131+
====
132+
The Aura CLI does not ask for confirmation and processes the commmand immediately.
133+
====
134+
+
135+
[source, bash, indent=0]
136+
----
137+
aura-cli data-api graphql delete YOUR_GRAPHQL_DATA_API_ID --instance-id YOUR_AURA_INSTANCE_ID --output table
138+
----
139+
+
140+
4. The GraphQL API is now deleted
141+
142+
143+
144+
== Provide feedback
145+
146+
We encourage feedback because it directly impacts the final product. Here's why it matters:
147+
148+
[square]
149+
* Shape the Product
150+
+
151+
Your feedback helps us refine features, fix bugs, and improve usability based on real user experiences.
152+
153+
154+
* Get a Product That Works for You
155+
+
156+
By sharing your thoughts, you influence the design and functionality to better meet your needs.
157+
158+
159+
* Catch Issues Early
160+
+
161+
Beta testing allows early identification and resolution of problems before the full release, ensuring a smoother experience.
162+
163+
164+
* Improve Performance and Reliability
165+
+
166+
We rely on real-world usage data to optimize speed, stability, and efficiency.
167+
168+
169+
By providing feedback, you're not just testing a product—you’re helping build a better one.
170+
171+
Please take a few moments to do this in our GitHub repository by (https://github.com/neo4j/graphql/issues/new/choose)[creating an issue] or mailto:jon.giffard@neo4j.com[send an email]
172+

0 commit comments

Comments
 (0)