Skip to content

Commit

Permalink
minor fixes to context docs (#6925)
Browse files Browse the repository at this point in the history
* minore fixes to context docs

* change image.getSrc to image.getUrl in context docs
  • Loading branch information
gwyneplaine authored and bladey committed Nov 24, 2021
1 parent 2fb85e6 commit dc3a98f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/pages/docs/apis/context.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ context = {

// Images API
images: {
getSrc,
getUrl,
getDataFromRef,
getDataFromStream,
},
Expand Down Expand Up @@ -138,7 +138,7 @@ type ImageData = {
};
```

`images.getSrc(mode, id, extension)`: Given a `mode`, `id`, and `extension` from an `ImageData` object, returns the `src` value representing the location from which the image can be accessed over HTTP.
`image.getUrl(mode, id, extension)`: Given a `mode`, `id`, and `extension` from an `ImageData` object, returns the `src` value representing the location from which the image can be accessed over HTTP.

`async images.getDataFromRef(ref)`: Given a `ref` string, taken from the `id` field of an existing image, returns an `ImageData` object.

Expand All @@ -150,7 +150,7 @@ These properties are used internally by Keystone and generally do not need to be

`totalResults`: The cumulative total number of results returned by the current request. See [`config.graphql.queryLimits`](./config#graphql).

`maxTotalResults`: The maximum number of results which can be returned before a query limit error is triggered. See [`config.graphql.queryLimits`](./apis/config#graphql).
`maxTotalResults`: The maximum number of results which can be returned before a query limit error is triggered. See [`config.graphql.queryLimits`](./config#graphql).

### Deprecated

Expand Down

0 comments on commit dc3a98f

Please sign in to comment.