Skip to content

Commit 8d6d090

Browse files
committed
replaced screenshots in toolbox page and modified structure
1 parent 6307df8 commit 8d6d090

File tree

6 files changed

+18
-24
lines changed

6 files changed

+18
-24
lines changed
-1023 Bytes
Loading
-198 KB
Loading
-151 KB
Loading

modules/ROOT/pages/getting-started/graphql-aura.adoc

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ This tutorial shows you how to create and use a GraphQL Data API in Aura Console
55

66
== Create a GraphQL Data API
77

8-
In the Aura Console, select **Data services** > **Data APIs** from the left side navigation.
9-
Use **Create API**.
8+
In the Aura Console, select **Data services** > **Data APIs** from the left side navigation and then **Create API**.
109

1110

1211
=== Details
@@ -43,11 +42,10 @@ type Category @node {
4342

4443
The type definitions describe what parts of the graph database in the AuraDB are accessible by requests made via the GraphQL API.
4544

46-
If you already have data in the AuraDB, you can obtain your type definitions via the https://graphql-toolbox.neo4j.io[Neo4j GraphQL Toolbox].
45+
Alternatively, if you already have data in the AuraDB, you can obtain your type definitions via the https://graphql-toolbox.neo4j.io[Neo4j GraphQL Toolbox].
4746
The toolbox can connect to the AuraDB and automatically create type definitions and allow GraphQL operations.
4847

49-
//link
50-
If you are using GraphQL Federation then make sure to select **Enable GraphQL subgraph**.
48+
If you are using link:https://graphql.org/learn/federation/[GraphQL Federation] then make sure to select **Enable GraphQL subgraph**.
5149

5250

5351
=== Cross-Origin Resource Sharing (CORS) policy
@@ -71,10 +69,8 @@ All requests to the GraphQL API are authenticated and there are two options for
7169
It is possible to use these in combination and have multiples of each.
7270

7371
Select **API Key** from the dropdown list and enter a name.
74-
7572
The API key will be shown after the GraphQL API key has been created.
7673

77-
7874
[CAUTION]
7975
====
8076
It is not recommended to use API keys with user-facing applications that are using the GraphQL API.
@@ -105,8 +101,7 @@ You can see the status via **Data APIs** from the left side navigation.
105101

106102
== Create nodes in the database
107103

108-
When the status for the GraphQL API is "Ready" you can send GraphQL requests to it.
109-
As all requests are subject to authentication, you must include the API key.
104+
When the status for the GraphQL API is **Ready** you can send GraphQL requests to it.
110105

111106

112107
=== Via cURL

modules/ROOT/pages/getting-started/graphql-self-hosted.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ This tutorial shows you how to:
1515
- The examples use the default `npm` package manager, but you can use other package managers.
1616
- Set up a https://neo4j.com[Neo4j database].
1717
Make sure it fulfills the xref::index.adoc#_requirements[requirements], including the necessary plugins.
18-
//Populate the database, for example with the Northwind dataset, available link::https://neo4j.com/docs/getting-started/appendix/example-data/[here].
19-
//The tutorial examples refer to this dataset.
2018

2119

2220
== Set up a directory

modules/ROOT/pages/getting-started/toolbox.adoc

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,13 @@ With it, you can:
1818
Before you start using the Toolbox, make sure you have followed all xref:index.adoc#_requirements[requirements] to run a Neo4j database.
1919
You can use https://neo4j.com/docs/desktop-manual/current/[Neo4j Desktop] or https://neo4j.com/docs/aura/auradb/[Neo4j AuraDB] for that.
2020

21+
2122
== Set the type definitions
2223

23-
. Set your type definitions directly in the Toolbox editor or introspect the Neo4j database you connected to.
24-
+
25-
If you followed the xref:getting-started/graphql-self-hosted.adoc[self-hosted GraphQL tutorial], you should see these type definitions in the GraphQL Toolbox:
26-
+
24+
Set your type definitions directly in the Toolbox editor or introspect the Neo4j database you connected to.
25+
26+
If you followed the xref:getting-started/graphql-self-hosted.adoc[self-hosted GraphQL tutorial], use **Introspect** to see these type definitions in the GraphQL Toolbox:
27+
2728
[source, graphql, indent=0]
2829
----
2930
type Product @node {
@@ -36,13 +37,15 @@ type Category @node {
3637
products: [Product!]! @relationship(type: "PART_OF", direction: IN)
3738
}
3839
----
39-
+
40-
// new screenshot
40+
4141
image::toolbox-schema-view.png[GraphQL Toolbox schema view]
4242

43-
. Click the button "Build schema" and then go to the Query editor tab.
4443

45-
. Query the Neo4j database using the autogenerated GraphQL queries and mutations from the `@neo4j/graphql` library:
44+
== Build the schema and query the database
45+
46+
**Build schema** which takes you to **Query editor** tab.
47+
48+
Query the Neo4j database. Paste the following or interact with the autogenerated GraphQL queries and mutations from the `@neo4j/graphql` library from the **Explorer**:
4649
+
4750
[source, graphql, indent=0]
4851
----
@@ -52,8 +55,7 @@ image::toolbox-schema-view.png[GraphQL Toolbox schema view]
5255
}
5356
}
5457
----
55-
+
56-
// new screenshot
58+
5759
image::toolbox-editor-view.png[GraphQL Toolbox editor view]
5860

5961
The query returns the name of the single product in the database:
@@ -63,11 +65,10 @@ The query returns the name of the single product in the database:
6365
{ "data": { "products": [{ "productName": "New Product" }] } }
6466
----
6567

68+
6669
== Store type definitions as favorite
6770

6871
You can store your type definitions as favorites and access a range of settings to work with.
72+
In the **Type definitions** tab, the star icon will will save it as a favorite:
6973

70-
. Go to the Type definitions tab and click on the star icon to save it as a favorite:
71-
+
72-
//new screenshot
7374
image:toolbox-favorite.png[Save a type definition as favorite]

0 commit comments

Comments
 (0)