Skip to content

Added page for ending the beta #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Apr 10, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,7 @@ target/

# node modules
node_modules/
.env
.env

package-lock.json
yarn.lock
2 changes: 2 additions & 0 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@
** xref:aura-graphql/deploy-and-operate.adoc[]
** xref:aura-graphql/authentication-providers.adoc[]
** xref:aura-graphql/using-your-api.adoc[]
** xref:aura-graphql/ending-with-the-beta.adoc[]


* xref:introspector.adoc[Introspector]

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/aura-graphql/three-dots.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
172 changes: 172 additions & 0 deletions modules/ROOT/pages/aura-graphql/ending-with-the-beta.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
= Ending with the Beta

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

* Backup GraphQL Data API configuration
* Remove the GraphQL Data API
* Provide feedback

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.


== Backup the GraphQL Data API configuration

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

There are two ways to perform a backup

* Manually copy them one by one from the Console
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is "them"? the configuration settings?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the configuration settings.

* Using the Aura CLI to obtain everything in one operation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here - if it's about settings, we could say "all settings" instead of "everything"



=== Console
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

1. After entering the Console, select *Data API* from the left hand navigation bar
+
image::aura-graphql/console_data_api_sidebar.png[]
+

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*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the dots image can be removed

+
image::aura-graphql/console_data_api_edit_menu.png[]
+

3. Expand each of the sections and then make a note of the setting or copy as necessary
+
image::aura-graphql/console_data_api_edit.png[]
+
4. When you are finished, select *Back*


=== Aura CLI

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`]


1. Lookup the Aura instance ID that the GraphQL API is being used with
+
[source, bash, indent=0]
----
aura-cli instance list --output table
----
+

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.
+
[source, bash, indent=0]
----
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table
----
+

3. Finally, obtain the configuration of the GraphQL API itself that will be shown to you in the form of a JSON document.
+
[source, bash, indent=0]
----
aura-cli data-api graphql get YOUR_GRAPHQL_DATA_API_ID --instance-id YOUR_AURA_INSTANCE_ID
----
+

4. Save the output to safe location for any future use.

[NOTE]
====
Type Definitions are stored using Base64 encoding. You will need to decode them back to plain text before using with other systems.
====


== Removing the GraphQL Data API
This can be performed using the Console or with the Aura CLI. Both methods are described below

[WARNING]
====
Once the GraphQL Data API has been deleted, it cannot be recovered.
====


=== Console
1. After entering the Console, select *Data API* from the left hand navigation bar
+
image::aura-graphql/console_data_api_sidebar.png[]
+

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*

+
image::aura-graphql/console_data_api_delete_menu.png[]
+

3. Type in the name of your GraphQL API and then click *Delete*
+
image::aura-graphql/console_data_api_confirm_delete_menu.png[]
+

4. The GraphQL API will now be deleted.



=== Aura CLI
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`]

1. Locate the Aura instance ID that the GraphQL API is being used with.
+
[source, bash, indent=0]
----
aura-cli instance list --output table
----
+

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.
+
[source, bash, indent=0]
----
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table
----
+

3. Delete the GraphQL API.
+
[WARNING]
====
The Aura CLI does not ask for confirmation and processes the commmand immediately.
====
+
[source, bash, indent=0]
----
aura-cli data-api graphql delete YOUR_GRAPHQL_DATA_API_ID --instance-id YOUR_AURA_INSTANCE_ID --output table
----
+
4. The GraphQL API is now deleted



== Provide feedback

We encourage feedback because it directly impacts the final product. Here's why it matters:

[square]
* Shape the Product
+
Your feedback helps us refine features, fix bugs, and improve usability based on real user experiences.


* Get a Product That Works for You
+
By sharing your thoughts, you influence the design and functionality to better meet your needs.


* Catch Issues Early
+
Beta testing allows early identification and resolution of problems before the full release, ensuring a smoother experience.


* Improve Performance and Reliability
+
We rely on real-world usage data to optimize speed, stability, and efficiency.


By providing feedback, you're not just testing a product—you’re helping build a better one.

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]