Skip to content

Commit a1ef9e7

Browse files
committed
chore: fix note format
1 parent fe74a18 commit a1ef9e7

File tree

4 files changed

+12
-9
lines changed

4 files changed

+12
-9
lines changed

reshape/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Reshaping is combined with access control of GraphQL fields so that
2828

2929
In all of the reshaping examples fields that are part of the reshaped api are accessible with no authorization.
3030

31-
> **Note**
31+
> [!NOTE]
3232
> Any reshaped GraphQL schema can also be expanded with any StepZen GraphQL functionality, such as adding fields with `@materializer` or adding `@sequence` fields that invoked fields from reshaped and or original schema.
3333
3434
## Techniques

reshape/fields/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This is achieved with a combination of:
1111
- Use of `@materializer` for the [new root operation type fields](exposed.graphql).
1212
- [Field based access control](config.yaml) to only expose the new fields.
1313

14-
> **Note**
14+
> [!NOTE]
1515
> Even though this schema uses `@graphql` the techniques are independent of the data coming from a backend GraphQL endpoint, the reshaping is just against fields in the schema regardless of their source.
1616
1717
## Rename
@@ -59,7 +59,7 @@ the `city` field is a leaf `String`, rather than being buried in a `Location` ob
5959

6060
[`Query.humanName`](exposed.graphql#L32-L35) uses the selection `human { name }` which selects just a `Human`'s name. It is effectively executing `query ($id:ID!) {human(id:$id) { name }}` when `humanName` is selected in an operation.
6161

62-
[`Query.droidFriends`](exposed.graphql#L37-L40) uses the selection `droid { friends }` where `friends` type is a composite type, `[Character]`. Even though the selected single field `friends` is a composite type, it has no selection in its `@materializer`. Instead, when an operation is executed that selects `droidFriends`, the selection against that field is applied to the selection of `friends`. For example the execution of this operation
62+
[`Query.droidFriends`](exposed.graphql#L37-L40) uses the selection `droid { friends }` where `friends` type is a composite type, `[Character]`. Even though the selected single field `friends` is a composite type, it has no selection in its `@materializer`. Instead, when an operation is executed that selects `droidFriends`, the selection against that field is applied to the selection of `friends`. For example the execution of this operation
6363

6464
```graphql
6565
query DroidFriends {
@@ -93,7 +93,7 @@ query DroidFriends {
9393
}
9494
```
9595

96-
> **Note**
96+
> [!NOTE]
9797
> The selection in the client's operation (`DroidFriends` in this example) against an annotated field with a selection in its `@materializer` can be **any valid selection** against the type of the annotated field, which include selections of nested fields that themselves have `@materializer`, with or without selections.
9898
9999
If anywhere in the selection any field is a list then the annotated field must have a type that is a list of the single field.
@@ -121,5 +121,4 @@ stepzen request -f operations.graphql --operation-name=DroidFriends -H Authoriza
121121
stepzen request -f operations.graphql --operation-name=HumanFriendsNames -H Authorization:
122122
```
123123

124-
> **Note**
125-
> `-H Authorization:` removes the authorization header automatically added by `stepzen request` to demonstrate the fields are public.
124+
> [!NOTE] > `-H Authorization:` removes the authorization header automatically added by `stepzen request` to demonstrate the fields are public.

reshape/subset/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,4 @@ stepzen request -f operations.graphql --operation-name=Human -H Authorization:
8787
stepzen request -f operations.graphql --operation-name=Version -H Authorization:
8888
```
8989

90-
> **Note** > `-H Authorization:` removes the authorization header automatically added by `stepzen request` to demonstrate the fields are public.
90+
> [!NOTE] > `-H Authorization:` removes the authorization header automatically added by `stepzen request` to demonstrate the fields are public.

routing/supplies/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@ based upon a condition against its field arguments.
1414
## Example
1515

1616
The abstract field in `Query` is:
17+
1718
```graphql
1819
expected(id:ID):Delivery
1920
```
21+
2022
which given a tracking identifier returns when a package is expected.
2123

2224
It is supplied by three fields, each with a condition.
@@ -29,7 +31,8 @@ It is supplied by three fields, each with a condition.
2931
tyd(id: ID!): ToYourDoor
3032
@supplies(query: "expected" if: {src: "$contains(id, /^TYD-/)", language: JSONATA})
3133
```
32-
> **Note**
34+
35+
> [!NOTE]
3336
> Implementation of the fields (`@rest`) have been omitted for brevity.
3437

3538
The script `src` must be ECMAScript 5.1 or JSONata and the field's arguments
@@ -42,11 +45,12 @@ Thus in this example if the tracking identifier starts with `FP-` a call
4245
is made to the FastPackage REST api, if it starts with `ROS-` a call to
4346
the `RainOrShine` REST api is called, `TYD-` a call to the To Your Door API otherwise no call is made.
4447

45-
> **Note**
48+
> [!NOTE]
4649
> The supplying fields can have any implementation, FastPackage could
4750
> be a GraphQL endpoint while RainOrShine a database query.
4851

4952
## Try it out
53+
5054
Login to your StepZen account, deploy the schema and then issue requests.
5155

5256
```shell

0 commit comments

Comments
 (0)