Skip to content

Commit c6fdc97

Browse files
committed
some more polish on various pages
1 parent 9658364 commit c6fdc97

File tree

3 files changed

+18
-11
lines changed

3 files changed

+18
-11
lines changed

modules/ROOT/pages/security/authorization.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@ type Post @authorization(filter: [
6666
}
6767
----
6868

69+
[NOTE]
70+
If there is no `operations` argument with a list of operations, the GraphQL Library treats the authorization configuration as if the full list of operations had been provided.
71+
6972

7073
=== Validating
7174

@@ -115,6 +118,9 @@ type Post @authorization(validate: [
115118
}
116119
----
117120

121+
[NOTE]
122+
If there is no `operations` argument with a list of operations, the GraphQL Library treats the authorization configuration as if the full list of operations had been provided.
123+
118124

119125
== Authorization without authentication
120126

modules/ROOT/pages/security/impersonation-and-user-switching.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Impersonation still authenticates with the database as the original configured u
1010
When impersonating a user, the query is run within the complete security context of the impersonated user and not the authenticated user (home database, permissions etc).
1111

1212
Consider the following an example of how to impersonate a different user per request.
13-
Here the user to impersonate is taken from a HTTP header `User`:
13+
Here the user to impersonate is taken from an HTTP header `User`:
1414

1515
[.tabbed-example]
1616
====

modules/ROOT/pages/security/operations.adoc

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
//:page-aliases: /authentication-and-authorization/reference/operations.adoc, /security/reference/operations.adoc
33
:description: This page describes how to set up authorization operations in the Neo4j GraphQL Library.
44

5-
This reference runs through a number of worked GraphQL queries and how each location in each query triggers the evaluation of different authentication/authorization rules.
5+
This page showcases a number of GraphQL queries and how you can trigger the evaluation of different authentication and authorization rules.
66

7-
Each relevant location has a comment such as `CREATE ON OBJECT Movie`, which means an authentication directive such as the following would be evaluated:
7+
Each relevant line has a comment such as `CREATE ON OBJECT Movie`, which means an authentication directive like the following is be evaluated:
88

99
[source, graphql, indent=0]
1010
----
@@ -14,15 +14,16 @@ type Movie @authentication(operations: [CREATE]) {
1414
}
1515
----
1616

17-
This also applies if the directive had no arguments, because `operations` defaults to _all_ operations.
17+
[NOTE]
18+
This also applies if the directive has no arguments because `operations` defaults to _all_ operations.
1819

1920
The following examples apply to the `@authentication` directive, and also any rules within an `@authorization` directive.
2021

2122
== Examples
2223

2324
=== Query
2425

25-
For a simple query, rules with `READ` in the operations will be evaluated for any type being read:
26+
For a simple query, rules with `READ` in the operations are evaluated for any type being read:
2627

2728
[source, graphql, indent=0]
2829
----
@@ -38,7 +39,7 @@ query {
3839

3940
=== Mutation
4041

41-
For create Mutations, `CREATE` rules on the object will be evaluated for each node created, as well as field definition rules:
42+
For `create` mutations, `CREATE` rules on the object are evaluated for each node created, as well as field definition rules:
4243

4344
[source, graphql, indent=0]
4445
----
@@ -55,7 +56,7 @@ mutation {
5556
}
5657
----
5758

58-
For single delete Mutations, rules with `DELETE` on the object will be evaluated:
59+
For single `delete` mutations, rules with `DELETE` on the object are evaluated:
5960

6061
[source, graphql, indent=0]
6162
----
@@ -66,7 +67,7 @@ mutation {
6667
}
6768
----
6869

69-
For delete Mutations with nested delete operations, rules with operation `DELETE` will be evaluated:
70+
For `delete` mutations with nested delete operations, rules with operation `DELETE` are evaluated:
7071

7172
[source, graphql, indent=0]
7273
----
@@ -80,7 +81,7 @@ mutation {
8081
}
8182
----
8283

83-
For a complex update Mutation with many effects, a variety of rules will be evaluated, as well as `READ` rules for the selection set:
84+
For a complex `update` mutation with many effects, a variety of rules is evaluated, as well as `READ` rules for the selection set:
8485

8586
[source, graphql, indent=0]
8687
----
@@ -104,7 +105,7 @@ mutation {
104105

105106
=== Subscription
106107

107-
For a simple Subscription to creation events, both `SUBSCRIBE` and `READ` operations trigger rules:
108+
For a simple subscription to creation events, both `SUBSCRIBE` and `READ` operations trigger rules:
108109

109110
[source, graphql, indent=0]
110111
----
@@ -117,7 +118,7 @@ subscription {
117118
}
118119
----
119120

120-
For a more complex Subscription to relationship events, both `SUBSCRIBE` is an operation, as well as `READ` to all relevant types:
121+
For a more complex subscription to relationship events, `SUBSCRIBE` is an operation as well as `READ` to all relevant types:
121122

122123
[source, graphql, indent=0]
123124
----

0 commit comments

Comments
 (0)