Skip to content

Commit 627b429

Browse files
rsill-neo4jrsill-neo4j
authored
Merge pull request #137 from neo4j/left-side-navigation-improvements
Left side navigation
2 parents d13cd5c + 3304db7 commit 627b429

File tree

9 files changed

+180
-129
lines changed

9 files changed

+180
-129
lines changed

‎modules/ROOT/content-nav.adoc‎

Lines changed: 86 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,86 @@
1-
* xref:index.adoc[Neo4j GraphQL Library]
2-
3-
** xref:getting-started/index.adoc[]
4-
*** xref:getting-started/toolbox.adoc[]
5-
6-
** Type definitions
7-
*** xref:type-definitions/types/index.adoc[]
8-
**** xref:type-definitions/types/scalar.adoc[Scalar]
9-
**** xref:type-definitions/types/temporal.adoc[Temporal]
10-
**** xref:type-definitions/types/spatial.adoc[Spatial]
11-
**** xref:type-definitions/types/interfaces.adoc[Interfaces]
12-
**** xref:type-definitions/types/unions.adoc[Union]
13-
**** xref:type-definitions/types/relationships.adoc[]
14-
*** xref:type-definitions/directives/index.adoc[]
15-
**** xref:type-definitions/directives/basics.adoc[]
16-
**** xref:type-definitions/directives/autogeneration.adoc[]
17-
**** xref:type-definitions/directives/custom-directives.adoc[]
18-
**** xref:type-definitions/directives/cypher.adoc[]
19-
**** xref:type-definitions/directives/default-values.adoc[]
20-
**** xref:type-definitions/directives/database-mapping.adoc[]
21-
**** xref:type-definitions/directives/indexes-and-constraints.adoc[]
22-
23-
** xref:schema-configuration/index.adoc[Schema configuration]
24-
*** xref:schema-configuration/type-configuration.adoc[]
25-
*** xref:schema-configuration/global-configuration.adoc[]
26-
*** xref:schema-configuration/field-configuration.adoc[]
27-
28-
** xref:queries-aggregations/index.adoc[Queries and aggregations]
29-
*** xref:queries-aggregations/queries.adoc[]
30-
*** xref:queries-aggregations/aggregations.adoc[]
31-
*** xref:queries-aggregations/filtering.adoc[]
32-
*** xref:queries-aggregations/sorting.adoc[]
33-
*** xref:queries-aggregations/pagination/index.adoc[]
34-
**** xref:queries-aggregations/pagination/offset-based.adoc[]
35-
**** xref:queries-aggregations/pagination/cursor-based.adoc[]
36-
37-
** xref:mutations/index.adoc[]
38-
*** xref:mutations/create.adoc[]
39-
*** xref:mutations/update.adoc[]
40-
*** xref:mutations/delete.adoc[]
41-
42-
** xref:subscriptions/index.adoc[]
43-
*** xref:subscriptions/getting-started.adoc[Getting started]
44-
*** xref:subscriptions/events.adoc[Events]
45-
*** xref:subscriptions/filtering.adoc[]
46-
*** xref:subscriptions/scaling.adoc[]
47-
*** xref:subscriptions/engines.adoc[Engines]
48-
49-
** xref:custom-resolvers.adoc[]
50-
51-
** xref:authentication-and-authorization/index.adoc[]
52-
*** xref:authentication-and-authorization/configuration.adoc[]
53-
*** xref:authentication-and-authorization/authentication.adoc[]
54-
*** xref:authentication-and-authorization/authorization.adoc[]
55-
*** xref:authentication-and-authorization/impersonation-and-user-switching.adoc[]
56-
*** xref:authentication-and-authorization/operations.adoc[]
57-
58-
** xref:introspector.adoc[Introspector]
59-
60-
** xref:migration/index.adoc[Migration guide]
61-
62-
** xref:ogm/index.adoc[]
63-
*** xref:ogm/installation.adoc[]
64-
*** xref:ogm/directives.adoc[]
65-
*** xref:ogm/selection-set.adoc[]
66-
*** xref:ogm/type-generation.adoc[]
67-
*** xref:ogm/subscriptions.adoc[]
68-
*** xref:ogm/reference.adoc[]
69-
70-
** xref:driver-configuration.adoc[]
71-
72-
** Frameworks and integrations
73-
*** xref:integrations/apollo-federation.adoc[]
74-
*** xref:integrations/relay-compatibility.adoc[]
75-
76-
** xref:troubleshooting.adoc[]
77-
78-
** xref:deprecations.adoc[Deprecations]
1+
* xref:index.adoc[Introduction]
2+
3+
* *Getting started*
4+
5+
* xref:getting-started/index.adoc[]
6+
* xref:getting-started/toolbox.adoc[]
7+
8+
* *Reference*
9+
10+
* xref:authentication-and-authorization/index.adoc[]
11+
** xref:authentication-and-authorization/configuration.adoc[]
12+
** xref:authentication-and-authorization/authentication.adoc[]
13+
** xref:authentication-and-authorization/authorization.adoc[]
14+
** xref:authentication-and-authorization/impersonation-and-user-switching.adoc[]
15+
** xref:authentication-and-authorization/operations.adoc[]
16+
17+
* Type definitions
18+
** xref:type-definitions/types/index.adoc[]
19+
*** xref:type-definitions/types/scalar.adoc[Scalar]
20+
*** xref:type-definitions/types/temporal.adoc[Temporal]
21+
*** xref:type-definitions/types/spatial.adoc[Spatial]
22+
*** xref:type-definitions/types/interfaces.adoc[Interfaces]
23+
*** xref:type-definitions/types/unions.adoc[Union]
24+
*** xref:type-definitions/types/relationships.adoc[]
25+
** xref:type-definitions/directives/index.adoc[]
26+
*** xref:type-definitions/directives/basics.adoc[]
27+
*** xref:type-definitions/directives/autogeneration.adoc[]
28+
*** xref:type-definitions/directives/custom-directives.adoc[]
29+
*** xref:type-definitions/directives/cypher.adoc[]
30+
*** xref:type-definitions/directives/default-values.adoc[]
31+
*** xref:type-definitions/directives/database-mapping.adoc[]
32+
*** xref:type-definitions/directives/indexes-and-constraints.adoc[]
33+
34+
* xref:schema-configuration/index.adoc[Schema configuration]
35+
** xref:schema-configuration/type-configuration.adoc[]
36+
** xref:schema-configuration/global-configuration.adoc[]
37+
** xref:schema-configuration/field-configuration.adoc[]
38+
39+
* xref:queries-aggregations/index.adoc[Queries and aggregations]
40+
** xref:queries-aggregations/queries.adoc[]
41+
** xref:queries-aggregations/aggregations.adoc[]
42+
** xref:queries-aggregations/filtering.adoc[]
43+
** xref:queries-aggregations/sorting.adoc[]
44+
** xref:queries-aggregations/pagination/index.adoc[]
45+
*** xref:queries-aggregations/pagination/offset-based.adoc[]
46+
*** xref:queries-aggregations/pagination/cursor-based.adoc[]
47+
48+
* xref:mutations/index.adoc[]
49+
** xref:mutations/create.adoc[]
50+
** xref:mutations/update.adoc[]
51+
** xref:mutations/delete.adoc[]
52+
53+
* xref:subscriptions/index.adoc[]
54+
** xref:subscriptions/getting-started.adoc[Getting started]
55+
** xref:subscriptions/events.adoc[Events]
56+
** xref:subscriptions/filtering.adoc[]
57+
** xref:subscriptions/scaling.adoc[]
58+
** xref:subscriptions/engines.adoc[Engines]
59+
60+
* *How-To*
61+
62+
* xref:custom-resolvers.adoc[]
63+
* xref:driver-configuration.adoc[]
64+
65+
* *Products*
66+
67+
* xref:introspector.adoc[Introspector]
68+
69+
* xref:ogm/index.adoc[]
70+
** xref:ogm/installation.adoc[]
71+
** xref:ogm/directives.adoc[]
72+
** xref:ogm/selection-set.adoc[]
73+
** xref:ogm/type-generation.adoc[]
74+
** xref:ogm/subscriptions.adoc[]
75+
** xref:ogm/reference.adoc[]
76+
77+
* *Frameworks and integrations*
78+
79+
* xref:integrations/apollo-federation.adoc[]
80+
* xref:integrations/relay-compatibility.adoc[]
81+
82+
* *Versions and support*
83+
84+
* xref:migration/index.adoc[Migration guide]
85+
* xref:deprecations.adoc[Deprecations]
86+
* xref:troubleshooting.adoc[]

‎modules/ROOT/pages/driver-configuration.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This page describes the configuration of the Neo4j GraphQL Library driver.
88

99
For the Neo4j GraphQL Library to work, either an instance of the https://github.com/neo4j/neo4j-javascript-driver[Neo4j JavaScript driver] must be passed in on construction of your `Neo4jGraphQL` instance (or alternatively, `OGM`), or a driver, session or transaction passed into the `context.executionContext` per request.
1010

11-
The examples in this page assume a Neo4j database running at "bolt://localhost:7687" with a username of "neo4j" and a password of "password".
11+
The examples in this page assume a Neo4j database running at "bolt://localhost:7687" with a username of "username" and a password of "password".
1212

1313
=== Neo4j GraphQL Library
1414

‎modules/ROOT/pages/getting-started/index.adoc‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
[[getting-started]]
2-
= Getting started
3-
:page-aliases: getting-started.adoc
2+
= Creating a new project
43
:description: This section describes how to get started with the Neo4j GraphQL Library.
54

65

‎modules/ROOT/pages/index.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[index]]
2-
= Neo4j GraphQL Library
2+
= Introduction
33
:page-aliases: introduction.adoc
44
:description: This section describes the Neo4j GraphQL Library.
55

‎modules/ROOT/pages/queries-aggregations/aggregations.adoc‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,48 @@
22
:description: This page describes aggregations supported by Neo4j GraphQL.
33
= Aggregations
44

5-
Based on the given <<queries-aggregations/index.adoc#examples-reference, type definitions>>, here is a list of fields that accept aggregations supported by Neo4j GraphQL:
5+
== Type definitions
6+
7+
Quries on this page assume the following type definitions:
8+
9+
[source, graphql, indent=0]
10+
----
11+
type Post {
12+
id: ID! @id
13+
content: String!
14+
creator: User! @relationship(type: "HAS_POST", direction: IN, properties: "PostedAt")
15+
createdAt: DateTime!
16+
}
17+
18+
type User {
19+
id: ID! @id
20+
name: String!
21+
age: Int!
22+
posts: [Post!]! @relationship(type: "HAS_POST", direction: OUT, properties: "PostedAt")
23+
friends: [User!]! @relationship(type: "FRIENDS_WITH", direction: OUT)
24+
}
25+
26+
type PostedAt @relationshipProperties {
27+
date: DateTime
28+
}
29+
----
30+
31+
For which the following query fields are generated:
32+
33+
[source, graphql, indent=0]
34+
----
35+
type Query {
36+
posts(where: PostWhere, options: PostOptions): [Post!]!
37+
postsAggregate(where: PostWhere): PostAggregationSelection!
38+
39+
users(where: UserWhere, options: UserOptions): [User!]!
40+
usersAggregate(where: UserWhere): UserAggregationSelection!
41+
}
42+
----
43+
44+
== Aggregation fields
45+
46+
Based on the type definitions, here is a list of fields that accept aggregations supported by Neo4j GraphQL:
647

748
[cols="1,1,2"]
849
|===

‎modules/ROOT/pages/queries-aggregations/index.adoc‎

Lines changed: 5 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -8,45 +8,8 @@ Each of these fields, by their part, accepts two arguments used for *filtering*,
88

99
This section addresses the following topics:
1010

11-
* xref:queries-aggregations/queries.adoc[Queries] - How to read or fetch values.
12-
* xref:queries-aggregations/aggregations.adoc[Aggregations] - How to combine lists of types from different sources into a single list.
13-
* xref:queries-aggregations/filtering.adoc[Filtering] - How to filter query results to find objects.
14-
* xref:queries-aggregations/sorting.adoc[Sorting] - How to sort query results by each individual field.
15-
16-
[#examples-reference]
17-
*All examples featured in this section use the following type definitions:*
18-
19-
[source, graphql, indent=0]
20-
----
21-
type Post {
22-
id: ID! @id
23-
content: String!
24-
creator: User! @relationship(type: "HAS_POST", direction: IN, properties: "PostedAt")
25-
createdAt: DateTime!
26-
}
27-
28-
type User {
29-
id: ID! @id
30-
name: String!
31-
age: Int!
32-
posts: [Post!]! @relationship(type: "HAS_POST", direction: OUT, properties: "PostedAt")
33-
friends: [User!]! @relationship(type: "FRIENDS_WITH", direction: OUT)
34-
}
35-
36-
type PostedAt @relationshipProperties {
37-
date: DateTime
38-
}
39-
----
40-
41-
For which the following query fields are generated:
42-
43-
[source, graphql, indent=0]
44-
----
45-
type Query {
46-
posts(where: PostWhere, options: PostOptions): [Post!]!
47-
postsAggregate(where: PostWhere): PostAggregationSelection!
48-
49-
users(where: UserWhere, options: UserOptions): [User!]!
50-
usersAggregate(where: UserWhere): UserAggregationSelection!
51-
}
52-
----
11+
* xref:queries-aggregations/queries.adoc[Queries] - Read or fetch values.
12+
* xref:queries-aggregations/aggregations.adoc[Aggregations] - Combine lists of types from different sources into a single list.
13+
* xref:queries-aggregations/filtering.adoc[Filtering] - Filter query results to find objects.
14+
* xref:queries-aggregations/sorting.adoc[Sorting] - Sort query results by individual fields.
15+
* xref:queries-aggregations/pagination/index.adoc[Pagination] - Navigate result pages.

‎modules/ROOT/pages/queries-aggregations/queries.adoc‎

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,48 @@
22
= Queries
33
:description: This page describes how to read or fetch values in the Neo4j GraphQL Library.
44

5+
== Type definitions
56

6-
Based on the given <<queries-aggregations/index.adoc#examples-reference, type definitions>>, here are two examples of how to write queries for reading or fetching values:
7+
Quries on this page assume the following type definitions:
8+
9+
[source, graphql, indent=0]
10+
----
11+
type Post {
12+
id: ID! @id
13+
content: String!
14+
creator: User! @relationship(type: "HAS_POST", direction: IN, properties: "PostedAt")
15+
createdAt: DateTime!
16+
}
17+
18+
type User {
19+
id: ID! @id
20+
name: String!
21+
age: Int!
22+
posts: [Post!]! @relationship(type: "HAS_POST", direction: OUT, properties: "PostedAt")
23+
friends: [User!]! @relationship(type: "FRIENDS_WITH", direction: OUT)
24+
}
25+
26+
type PostedAt @relationshipProperties {
27+
date: DateTime
28+
}
29+
----
30+
31+
For which the following query fields are generated:
32+
33+
[source, graphql, indent=0]
34+
----
35+
type Query {
36+
posts(where: PostWhere, options: PostOptions): [Post!]!
37+
postsAggregate(where: PostWhere): PostAggregationSelection!
38+
39+
users(where: UserWhere, options: UserOptions): [User!]!
40+
usersAggregate(where: UserWhere): UserAggregationSelection!
41+
}
42+
----
43+
44+
== Writing queries
45+
46+
Based on the type definitions, here are two examples of how to write queries for reading or retrieving values:
747

848
.Return all User nodes from their ID and name
949
[source, graphql, indent=0]

‎modules/ROOT/pages/schema-configuration/index.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ However, in some cases, it may be advisable to reduce the scope of the API produ
1010

1111
This section provides information on how to limit access to unwanted operations and reduce the size of the schema which can improve the performance:
1212

13-
- xref::schema-configuration/field-configuration.adoc[Field configuration] - How to remove fields from a GraphQL Object Type or a GraphQL Input Object Type.
13+
- xref::schema-configuration/type-configuration.adoc[Type configuration] - How to set up `Query`, `Mutation`, and `Subscription` types.
1414
- xref::schema-configuration/global-configuration.adoc[Global configuration] - How to globally disable specific types of operation.
15-
- xref::schema-configuration/type-configuration.adoc[Type configuration] - How to set up `Query`, `Mutation`, and `Subscription` types.
15+
- xref::schema-configuration/field-configuration.adoc[Field configuration] - How to remove fields from a GraphQL Object Type or a GraphQL Input Object Type.

‎modules/ROOT/pages/troubleshooting.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[[troubleshooting]]
22
= Troubleshooting
3-
:page-aliases: troubleshooting/index.adoc, troubleshooting/faqs.adoc, troubleshooting/security.adoc, \
3+
:page-aliases: troubleshooting/faqs.adoc, troubleshooting/security.adoc, \
44
troubleshooting/optimizing-create-operations.adoc, appendix/preventing-overfetching.adoc, appendix/index.adoc
55

66

0 commit comments

Comments
 (0)