Giao diện
API · cms-public
Trang sinh tự động
Parse từ schema.graphql (SDL backend export) bằng parser graphql. Mô tả và quyền lấy nguyên văn từ description trong SDL.
4 query · 0 mutation.
Query
publicArticles
Matrix A-04. Published articles, newest first (no body).
query · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
locale | String | ||
page | Int | ||
pageSize | Int |
Trả về PublicArticlePage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [PublicArticleSummary!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! | |
requestedLocale | String! | |
locale | String! | Locale of the items. Not the requested one when localeFallback (GAP-105). |
localeFallback | Boolean! | |
sourceStatus | SourceStatus! |
publicBanners
Matrix A-04. Banners live now for the REQUEST app (x-pi-app), in display order.
query · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
placement | CmsBannerPlacement |
Trả về [PublicBanner!]!
| Field | Kiểu | Mô tả |
|---|---|---|
id | ID! | |
title | String! | |
altText | String | |
image | PublicMedia | |
sortOrder | Int | |
target | PublicBannerTarget | |
targetStatus | PublicTargetStatus! |
publicContent
Matrix A-04. One published article by slug; draft, scheduled, unpublished and deleted are not_found.
query · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
slug | String! | ||
locale | String |
Trả về PublicArticle!
| Field | Kiểu | Mô tả |
|---|---|---|
id | ID! | |
slug | String! | |
locale | String! | |
requestedLocale | String! | |
localeFallback | Boolean! | True when the content is the vi base because the requested locale has none (GAP-105). |
title | String! | |
excerpt | String | |
cover | PublicMedia | |
categorySlug | String | |
categoryName | String | |
keywords | [String!]! | |
seoTitle | String | |
seoDescription | String | |
seoCanonicalUrl | String | https URL on an allowed host; null when none or no longer allowed. |
seoShareImage | PublicMedia | Public READY CMS image from our media store; null when none or gone. |
seoIndexable | Boolean! | False = ask search engines not to index it (not access control). No stored value reads true. |
publishedAt | DateTime! | |
version | Int! | Published version number. |
body | [PublicBlock!]! | |
sourceStatus | SourceStatus! | UNAVAILABLE when the stored body cannot be rendered safely; body is then empty. |
publicPage
Matrix A-04. One published content page by key; draft, scheduled and unpublished are not_found.
query · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
slug | String! | ||
locale | String |
Trả về PublicPageContent!
| Field | Kiểu | Mô tả |
|---|---|---|
id | ID! | |
slug | String! | |
locale | String! | |
requestedLocale | String! | |
localeFallback | Boolean! | True when the content is the vi base because the requested locale has none (GAP-105). |
title | String! | |
seoTitle | String | |
seoDescription | String | |
seoCanonicalUrl | String | |
seoShareImage | PublicMedia | |
seoIndexable | Boolean! | |
publishedAt | DateTime! | |
version | Int! | Published version number. |
body | [PublicBlock!]! | |
sourceStatus | SourceStatus! | UNAVAILABLE when the stored body cannot be rendered safely; body is then empty. |