You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Deploying a GraphQL 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:
6
+
Before you deploy a GraphQL API, complete the steps in xref::/aura-graphql-data-apis/prerequisites.adoc[Prerequisites].
7
+
Make sure that you have:
7
8
8
-
* The ID, username and password for the AuraDB
9
-
* A file containing the type definitions
9
+
* The ID, username and password for the AuraDB.
10
+
* A file containing the type definitions.
10
11
11
-
You are now ready to create the GraphQL API with the Aura CLI. Substitute the values in `CAPITALS` to match your setup:
12
+
You are now ready to create the GraphQL API with the Aura CLI.
13
+
Substitute the values in `CAPITALS` to match your setup:
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
23
+
Make sure to record the API key shown in the response as it will not be displayed again.
24
+
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 xref::/aura-graphql-data-apis/authentication-providers.adoc[Authentication providers].
22
25
====
23
26
24
27
There are other items of note in the response:
@@ -36,29 +39,34 @@ aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID
36
39
37
40
When the status changes to `ready`, the GraphQL API is available for servicing requests.
38
41
39
-
== Modifying an Existing GraphQL API
42
+
== Modifying an existing GraphQL API
40
43
41
-
It is possible to change the configuration of an existing GraphQL API. The following properties can be modified:
44
+
It is possible to change the configuration of an existing GraphQL API.
45
+
The following properties can be modified:
42
46
43
47
* Friendly name of the GraphQL API
44
48
* Username and/or password for the associated Aura instance
45
49
* Type definitions
46
50
47
-
To do this, use the Aura CLI update command which requires IDs of the GraphQL API and it’s linked AuraDB instance. The format of this Aura CLI command is as follows:
51
+
To do this, use the Aura CLI update command which requires IDs of the GraphQL API and its linked AuraDB instance.
52
+
The format of this Aura CLI command is as follows:
As the change takes a few moments to fully implement, you should check the status of the GraphQL 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`.
59
+
As the change takes a few moments to apply, check the status of the GraphQL API after performing this operation.
60
+
If the status is `updating` then the change is still being processed.
61
+
When the change is committed, the status will return to `ready`.
55
62
56
-
57
-
Additionally, it is possible to modify the authentication providers of GraphQL APIs. More on what these are and how to do this xref::/aura-graphql-data-apis/authentication-providers.adoc[here].
63
+
Additionally, it is possible to modify the authentication providers of GraphQL APIs.
64
+
To learn more, see xref::/aura-graphql-data-apis/authentication-providers.adoc[Authentication providers].
58
65
59
66
== Deleting a GraphQL API
60
67
61
-
When you no longer require the GraphQL API then delete it by using the Aura CLI delete command. This will require the Aura instance ID and ID of the GraphQL API.
68
+
When you no longer require the GraphQL API then delete it by using the Aura CLI delete command.
69
+
This requires the Aura instance ID and the ID of the GraphQL API.
62
70
63
71
The format of this command is as follows:
64
72
@@ -67,7 +75,7 @@ The format of this command is as follows:
0 commit comments