Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update schema.md #2215

Merged
merged 2 commits into from
Jan 12, 2020
Merged

Update schema.md #2215

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d11b77
Update schema.md
bartduisters Jan 11, 2020
ee77ee0
Merge branch 'master' into patch-13
MadeByMike Jan 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/guides/schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,12 +379,12 @@ A note on definitions:

- **To-single / To-many** refer to _the number of related items_ (1, or more than 1).
- **One-way / Two-way** refer to _the direction of the query_.
- **Backlinks** refer to a special type of two-way relationships where _one
- **Back References** refer to a special type of two-way relationships where _one
field can update a related list's field as it changes_.

#### To-single Relationships

When you have a single related item you want to refer to, a _To-single_
When you have a single related item you want to refer to, a _to-single_
relationship allows storing that item, and querying it via the GraphQL API.

```javascript
Expand All @@ -406,7 +406,7 @@ keystone.createList('User', {
Here we've defined the `createdBy` field to be a `Relationship` type, and
configured its relation to be the `User` list by setting the `ref` option.

A query for a To-single Relationship field will return an object with the
A query for a to-single relationship field will return an object with the
requested data:

```graphql
Expand Down Expand Up @@ -470,7 +470,7 @@ keystone.createList('User', {
});
```

A query for a To-many Relationship field will return an array of objects with
A query for a to-many relationship field will return an array of objects with
the requested data:

```graphql
Expand Down Expand Up @@ -525,11 +525,11 @@ In the [to-single](#to-single-relationships) and
[to-many](#to-many-relationships) examples above, we were only querying _in one
direction_; always from the list with the Relationship field.

Often, you will want to query _in both directions_ (aka _two-way_). For example;
you may want to list all Todo tasks for a User, _and_ want to list the User who
Often, you will want to query _in both directions_ (aka _two-way_). For example:
you may want to list all Todo tasks for a User _and_ want to list the User who
owns a Todo.

A Two-way relationship requires having a `Relationship` field on both lists:
A two-way relationship requires having a `Relationship` field on both lists:

```javascript
keystone.createList('Todo', {
Expand Down Expand Up @@ -610,10 +610,10 @@ The database would look like:

</div>

Note the two Relationship fields in this example _know nothing about each other_.
Note the two relationship fields in this example _know nothing about each other_.
They are not specially linked. This means if you update data in one place, you
must update it in both. To automate this and link two Relationship fields, read
on about _[Relationship Back References](#relationship-back-references)_.
must update it in both. To automate this and link two relationship fields, read
on about `Relationship Back References` below.

#### Relationship Back References

Expand Down Expand Up @@ -746,7 +746,7 @@ mutation {
}
```

Our database would like:
Our database would look like:

<div style={{ border: '1px solid lightgray', padding: '1rem' }}>
<code><strong>Todo</strong></code>
Expand Down