Skip to content

Commit 29b26eb

Browse files
committed
review suggestions
1 parent c1e6c05 commit 29b26eb

File tree

6 files changed

+27
-6
lines changed

6 files changed

+27
-6
lines changed

modules/ROOT/pages/directives/custom-logic.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -498,6 +498,11 @@ type Journal implements Publication @node {
498498

499499
== `@populatedBy`
500500

501+
[NOTE]
502+
====
503+
Data APIs created in Aura Console currently do not support the `@populatedBy` directive.
504+
====
505+
501506
This directive is used to specify a callback function, which is executed during GraphQL query parsing,
502507
to populate fields which have not been provided within the input.
503508

modules/ROOT/pages/directives/indexes-and-constraints.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,11 @@ query {
168168
[#_vector_index_search]
169169
== `@vector`
170170

171+
[NOTE]
172+
====
173+
Data APIs created in Aura Console currently do not support the `@vector` directive.
174+
====
175+
171176
With the `@vector` GraphQL directive you can query your database to perform a vector index search.
172177
Queries are performed by passing in either a vector index or a query phrase.
173178

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ In the Aura Console, select **Data services** > **Data APIs** from the left side
1111
=== Details
1212

1313
Provide a name for your new API as well the instance data for the instance you want to use under **Details**.
14+
Also do **Enable introspection** and **Enable field suggestions** for use with xref:#_via_apollo_server[Apollo Server].
1415

1516
[CAUTION]
1617
====

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ type Category @node {
4040

4141
image::toolbox-schema-view.png[GraphQL Toolbox schema view]
4242

43+
[NOTE]
44+
====
45+
If you modified your database after following the xref:getting-started/graphql-self-hosted.adoc[self-hosted GraphQL tutorial], you may see different introspection results.
46+
====
47+
4348

4449
== Build the schema and query the database
4550

modules/ROOT/pages/index.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,14 @@ The Neo4j GraphQL Library features:
2525
- xref::/types/index.adoc[Types], including temporal and spatial.
2626
- Support for both node and relationship properties.
2727
- Extensibility through the xref::/directives/custom-logic.adoc#_cypher[`@cypher` directive] and/or xref::/directives/custom-logic.adoc#_customresolver[Custom Resolvers].
28-
- Extensive xref::filtering.adoc[Filtering] and xref::queries-aggregations/sorting.adoc[Sorting] options.
28+
- Extensive xref::filtering.adoc[Filtering], xref::queries-aggregations/sorting.adoc[Sorting] and xref::/queries-aggregations/pagination.adoc[Pagination] options.
2929
- Options for xref::/directives/database-mapping.adoc[Database mapping] and value xref::/directives/autogeneration.adoc[Autogeneration].
30-
- xref::/queries-aggregations/pagination.adoc[Pagination] options.
3130
- xref::/security/index.adoc[Security options] and additional xref::schema-configuration/index.adoc[Schema Configuration].
3231
- A xref::getting-started/toolbox.adoc[Toolbox] (UI) to experiment with your Neo4j GraphQL API on Neo4j Desktop.
3332

3433

3534
== Interaction
3635

37-
// Modify link below and add info about aura graphql
38-
3936
In xref::getting-started/graphql-aura.adoc[] as well as xref::getting-started/graphql-self-hosted.adoc[], a GraphQL server is used to serve the GraphQL schema, so you can interact directly with your API with no frontend.
4037
In case you prefer to use frontend frameworks, these are some clients that interact with GraphQL APIs:
4138

@@ -47,8 +44,11 @@ In case you prefer to use frontend frameworks, these are some clients that inter
4744
== Deployment
4845

4946
There are a variety of methods for deploying GraphQL APIs.
50-
In the xref::getting-started/index.adoc[Getting Started] guide, Apollo Server is being used for demonstration.
51-
You can check their own documentation about https://www.apollographql.com/docs/apollo-server/deployment[Deployment] for more details.
47+
48+
With Aura Console, you can create and use a GraphQL API, see xref::getting-started/graphql-aura.adoc[].
49+
50+
The xref::getting-started/graphql-self-hosted.adoc[] guide uses Apollo Server.
51+
You can check the Apollo documentation on https://www.apollographql.com/docs/apollo-server/deployment[Deployment] for more details.
5252

5353

5454
== Versioning

modules/ROOT/pages/security/subscriptions-authorization.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
:description: This page describes how to set up authorization features for subscriptions in the Neo4j GraphQL Library.
33
= Subscriptions authorization
44

5+
[NOTE]
6+
====
7+
Data APIs created in Aura Console currently do not support the `subscriptionsAuthorization` directive.
8+
====
9+
510
Subscriptions require their own authorization rules, which are configured with the `@subscriptionsAuthorization` directive.
611
These rules are different to authorization rules for queries and mutations because they use filtering rules available for subscriptions events.
712
These filtering rules can only be used to filter against the properties of the nodes impacted by the events.

0 commit comments

Comments
 (0)