Skip to content

Commit 8063f77

Browse files
committed
Remove extra whitespace
1 parent b721b25 commit 8063f77

File tree

5 files changed

+30
-31
lines changed

5 files changed

+30
-31
lines changed

modules/ROOT/pages/aura-graphql/api-creation.adoc

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ image::aura-graphql/create/details.png[]
2323
====
2424
If you set **Enable introspection** and **Enable field suggestions** for production systems the information they provide can be used by malicious actors to reverse-engineer your GraphQL schema and execute arbitrary operations.
2525
26-
**Enable introspection** allows you to query the schema and discover the available queries, mutations, subscriptions, types and fields in the GraphQL API.
26+
**Enable introspection** allows you to query the schema and discover the available queries, mutations, subscriptions, types and fields in the GraphQL API.
2727
2828
**Enable field suggestions** provides suggestions that hint towards GraphQL typos.
2929
Even with just field suggestions enabled, it is possible for a malicious actor to discover your entire schema.
@@ -32,9 +32,9 @@ Even with just field suggestions enabled, it is possible for a malicious actor t
3232
. Type definitions
3333
+
3434
This is where you describe the graph database in the AuraDB that the GraphQL API will be used with.
35-
The Type Definitions are the same as those used with Neo4j GraphQL Library with the exception that custom resolvers cannot be used.
35+
The Type Definitions are the same as those used with Neo4j GraphQL Library with the exception that custom resolvers cannot be used.
3636
+
37-
If you already have data in the AuraDB, a quick way to obtain Type Definitions is to use the https://graphql-toolbox.neo4j.io[Neo4j GraphQL Toolbox]. This facility has the ability to connect to an AuraDB, automatically create Type Definitions and allow GraphQL operations.
37+
If you already have data in the AuraDB, a quick way to obtain Type Definitions is to use the https://graphql-toolbox.neo4j.io[Neo4j GraphQL Toolbox]. This facility has the ability to connect to an AuraDB, automatically create Type Definitions and allow GraphQL operations.
3838
+
3939
Alternatively you can write your own Type Definition from first principles by following the guidance provided in xref:index.adoc[Neo4j GraphQL Library] documention
4040
+
@@ -51,13 +51,13 @@ This includes development environments such as node.js, which serves content on
5151
This also holds for using web-based tooling for GraphQL APIs such as https://studio.apollographql.com/[Apollo Studio].
5252
+
5353
This is not needed if a non-browser-based application is using the GraphQL API as CORS does not apply to those.
54-
For example, if you are trying out GraphQL operations using cURL.
54+
For example, if you are trying out GraphQL operations using cURL.
5555
+
5656
[NOTE]
5757
====
5858
The URL entered in the CORS policy must be an exact match.
5959
For example, http://localhost is not the same as http://localhost:3000/.
60-
Wildcards are not supported.
60+
Wildcards are not supported.
6161
====
6262
+
6363
To add a CORS policy entry, enter the exact URL, including HTTP/S and any port number, in the **Origin box**.
@@ -68,12 +68,12 @@ image::aura-graphql/create/cors-policy.png[]
6868
. Authentication providers
6969
+
7070
All requests to the GraphQL API are authenticated and there are two options for the type of authentication: API key or JSON Web Key Set (JWKS).
71-
It is possible to use these in combination and have multiples of each.
71+
It is possible to use these in combination and have multiples of each.
7272
+
7373
After choosing the authentication provider from the dropdown list, enter a friendly name.
7474
This is all that is needed when using API key.
7575
The API key will be shown after the GraphQL API key has been created.
76-
If you are using JWKS, provide a friendly name and the URL from your identity provider that is used to verify JWKS tokens.
76+
If you are using JWKS, provide a friendly name and the URL from your identity provider that is used to verify JWKS tokens.
7777
+
7878
Add more more providers via **Add authentication provider**.
7979
+
@@ -92,7 +92,7 @@ A 3rd party identity provider with JWKS provides better security and allows for
9292
+
9393
Sizing a GraphQL API is based on the size and complexity of the type definitions and the workload that is serviced.
9494
Larger sizes have a higher hourly cost.
95-
If the cost is not displayed, refer to the agreement you have with Neo4j.
95+
If the cost is not displayed, refer to the agreement you have with Neo4j.
9696
+
9797
image::aura-graphql/create/sizing.png[]
9898
+
@@ -109,8 +109,8 @@ Store this information securely as it cannot be retrieved again.
109109
Select **I understand** and then **Close** once you have done this.
110110
+
111111
image::aura-graphql/create/save-api-key.png[]
112-
+
113-
. The GraphQL API will now be provisioned.
112+
+
113+
. The GraphQL API will now be provisioned.
114114
You can see the status via **Data APIs** from the left side navigation.
115115
When the status changes to "Ready", the API is ready to use.
116116
If it has a status of 'Error', use the three dots icon and **Edit** from the menu to change the configuration.
@@ -124,7 +124,7 @@ The authentication providers can be modified using subsequent CLI commands.
124124

125125
To create a GraphQL API with the Aura CLI, proceed as follows.
126126

127-
. Find the AuraDB instance ID
127+
. Find the AuraDB instance ID
128128
+
129129
From the table, locate the ID of the Aura instance that the GraphQL API will be used with.
130130
+
@@ -135,7 +135,7 @@ aura-cli instance list
135135
+
136136
. Save type definitions
137137
+
138-
To avoid having to encode type definitions into base64 format to use directly with the Aura CLI, save them in a file.
138+
To avoid having to encode type definitions into base64 format to use directly with the Aura CLI, save them in a file.
139139
+
140140
. Create
141141
+
@@ -150,7 +150,7 @@ The response shows information about the new GraphQL API.
150150
Make sure you note the API Key and ID.
151151
+
152152
. Check progress
153-
+
153+
+
154154
To see if the GraphQL API is ready to use, run the following command:
155155
+
156156
[source, bash, indent=0]
@@ -159,4 +159,3 @@ aura-cli data-api graphql get YOUR_GRAPHQL_API_ID --instance-id YOUR_AURA_INSTAN
159159
----
160160

161161
If the status is "Ready", the API is ready to use.
162-

modules/ROOT/pages/aura-graphql/api-deletion.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
+
77
. Locate the GraphQL API that you wish to delete and use the three dots icon, then **Delete**.
88
+
9-
Confirm the deletion by typing the name of the GraphQL API in the dialog and select **Delete** again.
9+
Confirm the deletion by typing the name of the GraphQL API in the dialog and select **Delete** again.
1010
+
1111
image::aura-graphql/delete/confirm-deletion.png[]
1212

@@ -27,7 +27,7 @@ The Aura CLI does not ask for confirmation and processes the command immediately
2727
=== Looking up the IDs
2828

2929
. Find the ID of the AuraDB.
30-
+
30+
+
3131
Display a list of AuraDBs in a table:
3232
+
3333
[source, bash, indent=0]
@@ -45,11 +45,11 @@ Using the AuraDB ID, list any GraphQL API that it may have:
4545
----
4646
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID
4747
----
48-
+
48+
+
4949
From that table, locate the GraphQL API you want to modify and make a note of its ID.
5050

5151

52-
=== Delete the GraphQL API
52+
=== Delete the GraphQL API
5353

5454
Using both the AuraDB instance ID and the ID of the associated GraphQL API, you can now delete the GraphQL API itself:
5555

modules/ROOT/pages/aura-graphql/api-update.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ When the data API has a status of "Ready", the changes have been applied.
2626
There are three main commands used by the Aura CLI to modify a GraphQL API:
2727

2828
. `update`: Modify the general settings of a GraphQL Data API.
29-
. `cors-policy`: Change the Cross-Origin Resource Sharing (CORS) policy.
29+
. `cors-policy`: Change the Cross-Origin Resource Sharing (CORS) policy.
3030
. `auth-provider`: Manage the authentication providers used by the GraphQL API.
3131

3232

@@ -43,7 +43,7 @@ The Aura CLI does not ask for confirmation and processes a command immediately.
4343
=== Looking up the IDs
4444

4545
. Find the ID of the AuraDB.
46-
+
46+
+
4747
Display a list of AuraDBs in a table:
4848
+
4949
[source, bash, indent=0]
@@ -61,7 +61,7 @@ Using the AuraDB ID, list any GraphQL API that it may have:
6161
----
6262
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID
6363
----
64-
+
64+
+
6565
From that table, locate the GraphQL API you want to modify and make a note of its ID.
6666

6767

@@ -72,7 +72,7 @@ Using the IDs of both AuraDB and the GraphQL API, this is achieved with:
7272

7373
[source, bash, indent=0]
7474
----
75-
aura-cli data-api graphql get YOUR_GRAPHQL_API_ID --instance-id YOUR_AURA_INSTANCE_ID
75+
aura-cli data-api graphql get YOUR_GRAPHQL_API_ID --instance-id YOUR_AURA_INSTANCE_ID
7676
----
7777

7878

@@ -108,7 +108,7 @@ The authentication method is stored as an authentication provider.
108108

109109
There are advantages and disadvantages to both types.
110110
API keys are quickly set up but do not allow for access control and should not be used within a user-facing client application.
111-
JWKS (JSON Web Key Sets) authentication providers require an external identity provider but allow for fine-grained rules around authentication and authorization as part of a GraphQL API type definitions.
111+
JWKS (JSON Web Key Sets) authentication providers require an external identity provider but allow for fine-grained rules around authentication and authorization as part of a GraphQL API type definitions.
112112

113113
[CAUTION]
114114
====
@@ -121,17 +121,17 @@ We recommend you to use JWKS authentication providers in user-facing client appl
121121
+
122122
[source, bash, indent=0]
123123
----
124-
aura-cli data-api graphql auth-provider list --data-api-id YOUR_GRAPHQL_API_ID --instance-id YOUR_AURA_INSTANCE_ID
124+
aura-cli data-api graphql auth-provider list --data-api-id YOUR_GRAPHQL_API_ID --instance-id YOUR_AURA_INSTANCE_ID
125125
----
126126
+
127127
- Get the details of a specific authentication provider:
128128
+
129129
[source, bash, indent=0]
130130
----
131-
aura-cli data-api graphql auth-provider get YOUR_AUTH_PROVIDER_ID --data-api-id YOUR_GRAPHQL_API_ID --instance-id YOUR_AURA_INSTANCE_ID
131+
aura-cli data-api graphql auth-provider get YOUR_AUTH_PROVIDER_ID --data-api-id YOUR_GRAPHQL_API_ID --instance-id YOUR_AURA_INSTANCE_ID
132132
----
133133
+
134-
- Add a new API key.
134+
- Add a new API key.
135135
You can create a new API key and mark it as disabled to prevent its use.
136136
To do that, add `--disabled` to the command.
137137
It is only possible to enable the key via the Console.
@@ -163,13 +163,13 @@ aura-cli data-api graphql auth-provider delete --name YOUR_FRIENDLY_NAME --type
163163

164164
=== `cors-policy`
165165

166-
You can add or remove allowed origins for the CORS policy of the GraphQL API.
166+
You can add or remove allowed origins for the CORS policy of the GraphQL API.
167167

168168
- Display the existing allowed origins:
169169
+
170170
[source, bash, indent=0]
171171
----
172-
aura-cli data-api graphql get YOUR_GRAPHQL_API_ID --instance-id YOUR_AURA_INSTANCE_ID
172+
aura-cli data-api graphql get YOUR_GRAPHQL_API_ID --instance-id YOUR_AURA_INSTANCE_ID
173173
----
174174
+
175175
- Add a new origin:

modules/ROOT/pages/aura-graphql/aura-cli-configuration.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ To get the credentials, follow these steps depending on which version of the con
1515
+
1616
image::aura-graphql/aura-cli/account-dropdown.png[]
1717
+
18-
. The menu shows existing API keys if you already have any.
18+
. The menu shows existing API keys if you already have any.
1919
+
2020
image::aura-graphql/aura-cli/api-keys.png[]
2121
+
22-
. Use **Create**, then enter a a name for the API key and confirm with **Create**.
22+
. Use **Create**, then enter a a name for the API key and confirm with **Create**.
2323
+
2424
image::aura-graphql/aura-cli/api-keys-create.png[]
2525
+

modules/ROOT/pages/aura-graphql/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
Welcome to GraphQL for Neo4j AuraDB.
44

5-
If you would like to provide feedback, use our `#graphql` channel on our link:https://discord.gg/M8mTADEJ[Discord Community], or our link:https://community.neo4j.com/c/drivers-stacks/graphql/33[forums] to report issues, suggest improvements, or ask questions.
5+
If you would like to provide feedback, use our `#graphql` channel on our link:https://discord.gg/M8mTADEJ[Discord Community], or our link:https://community.neo4j.com/c/drivers-stacks/graphql/33[forums] to report issues, suggest improvements, or ask questions.

0 commit comments

Comments
 (0)