diff --git a/content/guides/04.connect/3.query-parameters.md b/content/guides/04.connect/3.query-parameters.md index 4169ab9a..c31c22f0 100644 --- a/content/guides/04.connect/3.query-parameters.md +++ b/content/guides/04.connect/3.query-parameters.md @@ -561,7 +561,7 @@ Saves the API response to a file. Valid values are `csv`, `json`, `xml`, `yaml`. ## Version -Queries a version of a record by version key when [content versioning](/guides/content/content-versioning) is enabled on a collection. Applies only to single item retrieval. +Queries a version of a record by version key when [content versioning](/guides/content/content-versioning) is enabled on a collection. ::callout{icon="material-symbols:info-outline"} **Reserved version keys** @@ -570,11 +570,18 @@ The keys `published` and `draft` are reserved. Use `published` (or `main` for ba ::code-group -```http [GET /items/posts/1] -?version=v1 +```http +GET /items/posts?version=v1 +GET /items/posts/1?version=v1 ``` ```graphql [GraphQL] +query { + posts(version: "v1") { + id + } +} + query { posts_by_id(id: 1, version: "v1") { id @@ -587,23 +594,30 @@ import { createDirectus, rest, readItem } from "@directus/sdk"; const directus = createDirectus("https://directus.example.com").with(rest()); const result = await directus.request( - readItem("posts", { + readItems("posts", { + version: "v1", + }), +); + +const item = await directus.request( + readItem("posts", 1, { version: "v1", }), ); ``` +### Version Meta + +When retrieving a versioned item, an additional `$meta` field is included in the response, containing metadata such as the version key and possibly an error message if the version failed to apply. + :: ## VersionRaw -Specifies to return relational delta changes as a [detailed output](https://directus.io/docs/guides/connect/relations#creating-updating-deleting) on a version record. +Specifies to return relational delta changes as a [detailed output](https://directus.io/docs/guides/connect/relations#creating-updating-deleting) on a version record. Applies only to single item retrieval. -::code-group - -```http [REST] -GET /items/posts/1 - ?version=v1&versionRaw=true +```http [GET /items/posts/1] +?version=v1&versionRaw=true ``` ```graphql [GraphQL]