Skip to content

Initial documentation for the GA release of GraphQL api #263

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
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
10 changes: 5 additions & 5 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,12 @@
* *Products*

* xref:aura-graphql/index.adoc[]
** xref:aura-graphql/prerequisites.adoc[]
** xref:aura-graphql/deploy-and-operate.adoc[]
** xref:aura-graphql/authentication-providers.adoc[]
** xref:aura-graphql/create-a-new-graphql-api.adoc[]
** xref:aura-graphql/view-a-graphql-api.adoc[]
** xref:aura-graphql/update-a-graphql-api.adoc[]
** xref:aura-graphql/delete-a-graphql-api.adoc[]
** xref:aura-graphql/using-your-api.adoc[]
** xref:aura-graphql/end-of-beta-phase.adoc[]

** xref:aura-graphql/auracli-prerequisites.adoc[]

* xref:introspector.adoc[Introspector]

Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
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.
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.
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 not shown.
Binary file not shown.
Binary file not shown.
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.
149 changes: 149 additions & 0 deletions modules/ROOT/pages/aura-graphql/auracli-prerequisites.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
= Configuring the Aura CLI for the GraphQL API

GraphQL for Neo4j AuraDB is managed using the Aura Console or the beta commands of Aura CLI command line tool. For the latter there are installation and configuration steps to be taken before it can be used.


== Obtain Aura API credentials

The Aura CLI communicates with Neo4j AuraDB platform via 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.

. Log in to the link:https://console.neo4j.io/[Neo4j Aura Console].
. Navigate to the top right where your account name is displayed and select it. A dropdown menu will apear.
+
image::aura-graphql/using-the-auracli/unified-console-account-dropdown.png[]
+
. From the menu, select *API keys*. This will show any existing API keys that you may already have.
+
image::aura-graphql/using-the-auracli/unified-console-api-keys.png[]
+
. Click *Create* to create a new API key.
+
image::aura-graphql/using-the-auracli/unified-console-api-keys-create.png[]
+
. In the pop-up window, enter a name for the API Key and then click *Create*.
+
image::aura-graphql/using-the-auracli/unified-console-api-keys-created.png[]
+
. The client ID and client secret are displayed. Be sure to record or save these as the client secret will not be shown again.


== Install the Aura CLI

. 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.
+
[NOTE]
====
Use Aura CLI version 1.1.0 or higher for managing your GraphQL APIs.
====
+
. Download the compressed file that matches your system. Make a note of the folder where the file is located.
. After the file has been downloaded, extract the contents.
. Open a command prompt and move to the location where you extracted the files.
. Complete the installation by moving the aura-cli executable file into the file path.
.. Mac/Linux users:
+
[source, bash, indent=0]
----
sudo mv aura-cli /usr/local/bin
----
+
.. Windows users:
+
[source, cmd, indent=0]
----
move aura-cli c:\windows\system32
----
+
. At the command prompt, type:
+
[source, bash, indent=0]
----
aura-cli -v
----
+
. You should see this:
+
[source, bash, indent=0]
----
aura version v1.1.0
----

[NOTE]
====
If you are using a Mac, you may receive a warning from Apple that aura-cli could not be verified.
If this happens, open *System Settings*, click *Privacy & Security* on the left, and scroll down on the right.
Click *Open Anyway*.
This should not happen again.
The aura-cli has been through the Apple certification process but it can take time to trickle down through the Apple ecosystem.
====

== Configure the Aura CLI

Configure the Aura CLI with the Aura API client ID and client secret you obtained earlier.


. At the command prompt, enter the following, using your values for the items in CAPITALS:
+
[source, bash, indent=0]
----
aura-cli credential add --name YOUR_LABEL --client-id YOUR_CLIENT_ID --client-secret YOUR_CLIENT_SECRET
----
+
. To confirm the credentials are working, list your Aura instances:
+
[source, bash, indent=0]
----
aura-cli instance list --output table
----


=== Enable the beta commands

Set the configuration option to make available the beta commands to use GraphQL for Neo4j AuraDB with the Aura CLI

. At the command prompt, enter the following:
+
[source, bash, indent=0]
----
aura-cli config set beta-enabled true
----
+
. Check if the commands are listed for the open beta:
+
[source, bash, indent=0]
----
aura-cli data-api graphql
----
+
. You should see this:
+
[source, bash, indent=0]
----
Allows you to programmatically provision and manage your GraphQL APIs

Usage:
aura-cli data-api graphql [command]

Available Commands:
auth-provider Allows you to programmatically manage Authentication providers for a specific GraphQL Data API
cors-policy Allows you to manage the Cross-Origin Resource Sharing (CORS) policy for a specific GraphQL Data API
create Creates a new GraphQL Data API
delete Delete a GraphQL Data API
get Get details of a GraphQL Data API
list Returns a list of GraphQL Data APIs
pause Pause a GraphQL Data API
resume Resume a GraphQL Data API
update Edit a GraphQL Data API

Flags:
-h, --help help for graphql

Global Flags:
--auth-url string
--base-url string
--output string

Use "aura-cli data-api graphql [command] --help" for more information about a command.
----
102 changes: 0 additions & 102 deletions modules/ROOT/pages/aura-graphql/authentication-providers.adoc

This file was deleted.

Loading