Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit e6c573d

Browse files
authored
update cmsPage schema (#4892)
1 parent bb954bc commit e6c573d

File tree

1 file changed

+10
-12
lines changed
  • guides/v2.3/graphql/reference

1 file changed

+10
-12
lines changed

guides/v2.3/graphql/reference/cms.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The `cmsPage` and `cmsBlock` endpoints return information about content pages an
99

1010
Return the contents of a CMS page:
1111

12-
`cmsPage(id: Int): CmsPage`
12+
`cmsPage(identifier: String): CmsPage`
1313

1414
Return the contents of one or more CMS blocks:
1515

@@ -19,11 +19,11 @@ Return the contents of one or more CMS blocks:
1919

2020
Attribute | Data type | Description
2121
--- | --- | ---
22-
`id` | Int | The ID of a CMS page
22+
`id` | Int | Deprecated. Use `identifier` instead.
23+
`identifier` | String | The identifier of a CMS page
2324
`identifiers` | [String] | An array containing a comma-separated list of block identifiers
2425

25-
26-
### CmsPage output attributes
26+
### CmsPage output attributes
2727

2828
The `CmsPage` object can contain the following attributes:
2929

@@ -38,8 +38,7 @@ Attribute | Data type | Description
3838
`title` | String | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab
3939
`url_key` |String | The URL key of the CMS page, which is often based on the `content_heading`
4040

41-
42-
### CmsBlocks output attributes
41+
### CmsBlocks output attributes
4342

4443
The `CmsBlocks` object contains an array of `items`, each of which can contain the following attributes:
4544

@@ -49,18 +48,17 @@ Attribute | Data type | Description
4948
`identifier` | String | The CMS block identifier
5049
`title` | String | The title assigned to the CMS block
5150

52-
5351
## Example usage
5452

5553
### Query a CMS page
5654

5755
The following query returns information about the "404 Not Found" CMS page:
5856

59-
**Request**
57+
**Request**
6058

61-
```
59+
```text
6260
{
63-
cmsPage(id: 1) {
61+
cmsPage(identifier: 1) {
6462
url_key
6563
title
6664
content
@@ -96,9 +94,9 @@ The following query returns information about the "404 Not Found" CMS page:
9694

9795
The following query returns information about the `login-data` block:
9896

99-
**Request**
97+
**Request**
10098

101-
```
99+
```text
102100
{
103101
cmsBlocks(identifiers: "login-data") {
104102
items {

0 commit comments

Comments
 (0)