Skip to content

Commit 814ddfd

Browse files
authored
Apply suggestions from code review
deploy and operate section
1 parent 7b2c1b5 commit 814ddfd

File tree

1 file changed

+23
-15
lines changed

1 file changed

+23
-15
lines changed
Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
= Deploy and Operate
1+
= Deploy and operate
22

33
== Deploy a GraphQL API
44

55

6-
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:
78

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.
1011

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:
1214

1315
[source, bash, indent=0]
1416
----
@@ -18,7 +20,8 @@ FULL_PATH_TO_YOUR_TYPE_DEFS --await
1820

1921
[NOTE]
2022
====
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
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].
2225
====
2326

2427
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
3639

3740
When the status changes to `ready`, the GraphQL API is available for servicing requests.
3841

39-
== Modifying an Existing GraphQL API
42+
== Modifying an existing GraphQL API
4043

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:
4246

4347
* Friendly name of the GraphQL API
4448
* Username and/or password for the associated Aura instance
4549
* Type definitions
4650

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:
4853

4954
[source, bash, indent=0]
5055
----
5156
aura-cli data-api graphql update YOUR_GRAPHQL_API_ID --instance-id YOUR_AURA_INSTANCE_ID <flags>
5257
----
5358

54-
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`.
5562

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].
5865

5966
== Deleting a GraphQL API
6067

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.
6270

6371
The format of this command is as follows:
6472

@@ -67,7 +75,7 @@ The format of this command is as follows:
6775
aura-cli data-api graphql delete YOUR_GRAPHQL_API_ID --instance-id YOUR_AURA_INSTANCE_ID
6876
----
6977

70-
[NOTE]
78+
[CAUTION]
7179
====
72-
There is no additional confirmation - the GraphQL API will start to be deleted as soon as you press the Enter key!
80+
There is no additional confirmation - the GraphQL API will start to be deleted as soon as you execute the command.
7381
====

0 commit comments

Comments
 (0)