Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Martin Bonnin <martin@mbonnin.net>
  • Loading branch information
BoD and martinbonnin authored May 17, 2024
1 parent 9a14a59 commit 1978a01
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions design-docs/Glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,21 +105,21 @@ A field that can take several shapes

### Record

A normalized entry representing part of a response object. It is a map of key fields to values.
Records are flat: when a field is a composite type, its value will be a reference to another Record.
A shallow map of a response object. Nested objects in the map values are replaced by a cache reference to another Record.

### Cache key

A unique identifier for a Record.
To avoid duplication it should be a function of the object, usually using its key fields, but by default will be a path of field keys from the root of the query to the field.
By default it is the path formed by all the field keys from the root of the query to the field referencing the Record.
To avoid duplication the Cache key can also be computed from the Record contents, usually using its key fields.

### Field key

A key that uniquely identifies a field within a Record. By default composed of the field name and the arguments passed to it.

### Key fields

The fields that uniquely identify an object.
Fields that are used to compute a Cache key for an object.

### Pagination arguments

Expand Down

0 comments on commit 1978a01

Please sign in to comment.