Skip to content

Commit f395215

Browse files
committed
Initial data api docs
1 parent 6ff3ae8 commit f395215

File tree

11 files changed

+300
-0
lines changed

11 files changed

+300
-0
lines changed

modules/ROOT/content-nav.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,11 @@
5858
5959
* *Products*
6060
61+
* xref:aura-graphql-data-apis/index.adoc[]
62+
** xref:aura-graphql-data-apis/prerequisites.adoc[]
63+
** xref:aura-graphql-data-apis/deploy-and-operate.adoc[]
64+
** xref:aura-graphql-data-apis/authentication-providers.adoc[]
65+
6166
* xref:introspector.adoc[Introspector]
6267
6368
* *Frameworks and integrations*
382 KB
Loading
336 KB
Loading
438 KB
Loading
336 KB
Loading
343 KB
Loading
382 KB
Loading
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[[auth-providers]]
2+
= Authentication Providers
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
= Deploy and Operate
2+
3+
== Deploy a GraphQL Data API
4+
5+
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:
7+
8+
* The ID, username and password for the AuraDB
9+
* A file containing the type definitions
10+
11+
You are now ready to create the GraphQL Data API with the Aura CLI. Substitute the values in `CAPITALS` to match your setup:
12+
13+
[source, bash, indent=0]
14+
----
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
17+
----
18+
19+
[NOTE]
20+
====
21+
Make sure to record the API key shown in the response as it will not be displayed again. If the API key is lost, a new one can be created by following the steps to create a new API key auth provider in the xref::/aura-graphql-data-apis/authentication-providers.adoc[authentication provider] section
22+
====
23+
24+
There are other items of note in the response:
25+
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
29+
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.
31+
32+
[source, bash, indent=0]
33+
----
34+
aura-cli data-api graphql list --instance-id YOUR-AURA-INSTANCE-ID
35+
----
36+
37+
When the status changes to `ready`, the GraphQL Data API is available for servicing requests.
38+
39+
== Modifying an Existing GraphQL Data API
40+
41+
It is possible to change the configuration of an existing GraphQL Data API. The following properties can be modified:
42+
43+
* Friendly name of the GraphQL Data API
44+
* Username and/or password for the associated Aura instance
45+
* Type definitions
46+
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:
48+
49+
[source, bash, indent=0]
50+
----
51+
aura-cli data-api graphql update YOUR-DATA-API-ID --instance-id YOUR-AURA-INSTANCE-ID <flags>
52+
----
53+
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`.
55+
56+
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].
58+
59+
== Deleting a GraphQL Data API
60+
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.
62+
63+
The format of this command is as follows:
64+
65+
[source, bash, indent=0]
66+
----
67+
aura-cli data-api graphql delete YOUR-DATA-API-ID --instance-id YOUR-AURA-INSTANCE-ID
68+
----
69+
70+
[NOTE]
71+
====
72+
There is no additional confirmation - the GraphQL Data API will start to be deleted as soon as you press the Enter key!
73+
====
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
= GraphQL for Neo4j AuraDB Beta
2+
3+
== Foreword
4+
5+
Welcome to the beta release of *GraphQL Data APIs for Neo4j AuraDB*.
6+
7+
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.
8+
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.
10+
11+
Here’s how you can help us get *GraphQL Data APIs for Neo4j AuraDB* ready for production:
12+
13+
- *Dive in*: Explore and test its features to your heart’s content.
14+
- *Break stuff*: We’d rather discover weak areas at this stage – go for it, don’t hold back.
15+
- *Share your experience*: Tell us what works, what doesn’t, and what you’d like to see in the future.
16+
- *Stay in touch*: Use email (`[email protected]`), our `#graphal` channel on our https://discord.gg/M8mTADEJ[Discord Community], or our https://community.neo4j.com/c/drivers-stacks/graphql/33[forums] to report issues, suggest improvements, or ask questions.
17+
18+
We value your time, creativity, and honest feedback – thank you for your trust and collaboration.
19+
20+
Sincerely,
21+
22+
Jonathan Giffard
23+
The GraphQL Team at Neo4j

0 commit comments

Comments
 (0)