Objects

Collection

Fields

Name	Description
name String!
slug String!
label String
path String!
format String
matches String
templates [JSON]
fields [JSON]
documents DocumentConnection!	Arguments Name Description before String after String first Float last Float sort String filter DocumentFilter folder String

Conditions

Implements

• Node
• Document

Fields

Name	Description
help Boolean
categories [ConditionsCategories]
id ID!
_sys SystemInfo!
_values JSON!

ConditionsCategories

Fields

Name	Description
name String!
description String
conditions [ConditionsCategoriesConditions]

ConditionsCategoriesConditions

Fields

Name	Description
condition String!
description String
active Boolean

ConditionsConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [ConditionsConnectionEdges]

ConditionsConnectionEdges

Fields

Name	Description
cursor String!
node Conditions

Dashboards

Implements

• Node
• Document

Fields

Name	Description
miniWriteDashboard Boolean
statusBar Boolean
help Boolean
dashboard1 Boolean
mediaDashboard Boolean
translationDashboard Boolean
brokenLinksDashboard Boolean
id ID!
_sys SystemInfo!
_values JSON!

DashboardsConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [DashboardsConnectionEdges]

DashboardsConnectionEdges

Fields

Name	Description
cursor String!
node Dashboards

Doc

Implements

• Node
• Document

Fields

Name	Description
help Boolean
lastmod String
modifiedBy String
title String!
body JSON
conditions [String]
description String
slug String
tags [String]
draft Boolean
review Boolean
translate Boolean
approved Boolean
published Boolean
unlisted Boolean
id ID!
_sys SystemInfo!
_values JSON!

DocConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [DocConnectionEdges]

DocConnectionEdges

Fields

Name	Description
cursor String!
node Doc

DocumentConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [DocumentConnectionEdges]

DocumentConnectionEdges

Fields

Name	Description
cursor String!
node DocumentNode

Folder

Fields

Name	Description
name String!
path String!

Generated

Implements

• Node
• Document

Fields

Name	Description
help Boolean
id ID!
_sys SystemInfo!
_values JSON!

GeneratedConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [GeneratedConnectionEdges]

GeneratedConnectionEdges

Fields

Name	Description
cursor String!
node Generated

GlossaryTerms

Implements

• Node
• Document

Fields

Name	Description
help Boolean
glossaryTerms [GlossaryTermsGlossaryTerms]
id ID!
_sys SystemInfo!
_values JSON!

GlossaryTermsConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [GlossaryTermsConnectionEdges]

GlossaryTermsConnectionEdges

Fields

Name	Description
cursor String!
node GlossaryTerms

GlossaryTermsGlossaryTermsGlossaryTerm

Fields

Name	Description
key String!
translations [GlossaryTermsGlossaryTermsGlossaryTermTranslations]

GlossaryTermsGlossaryTermsGlossaryTermTranslationsTranslation

Fields

Name	Description
lang String!
term String!
definition String!

Homepage

Implements

• Node
• Document

Fields

Name	Description
help Boolean
_warning String
label String!
title String
description String
blocks [HomepageBlocks]
id ID!
_sys SystemInfo!
_values JSON!

HomepageBlocksFeatures

Fields

Name	Description
items [HomepageBlocksFeaturesItems]

HomepageBlocksFeaturesItems

Fields

Name	Description
title String
description JSON
image String

HomepageBlocksHero

Fields

Name	Description
title String
subtitle String
description String
document HomepageBlocksHeroDocument
documentLabel String
secondaryButtonText String
secondaryButtonLink String
showHeroCard Boolean
heroCardTitle String
heroCardFeatures [HomepageBlocksHeroHeroCardFeatures]

HomepageBlocksHeroHeroCardFeatures

Fields

Name	Description
feature String

HomepageBlocksYouTubeEmbed

Fields

Name	Description
title String
url String
caption String

HomepageConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [HomepageConnectionEdges]

HomepageConnectionEdges

Fields

Name	Description
cursor String!
node Homepage

I18n

Implements

• Node
• Document

Fields

Name	Description
help Boolean
lastmod String
modifiedBy String
title String!
body JSON
conditions [String]
description String
slug String
tags [String]
draft Boolean
review Boolean
translate Boolean
approved Boolean
published Boolean
unlisted Boolean
id ID!
_sys SystemInfo!
_values JSON!

I18nConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [I18nConnectionEdges]

I18nConnectionEdges

Fields

Name	Description
cursor String!
node I18n

Media

Implements

• Node
• Document

Fields

Name	Description
media [MediaMedia]
id ID!
_sys SystemInfo!
_values JSON!

MediaConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [MediaConnectionEdges]

MediaConnectionEdges

Fields

Name	Description
cursor String!
node Media

MediaMedia

Fields

Name	Description
filename String!
path String!
size Float!
dimensions String
lastModified String

PageInfo

Fields

Name	Description
hasPreviousPage Boolean!
hasNextPage Boolean!
startCursor String!
endCursor String!

Pages

Implements

• Node
• Document

Fields

Name	Description
help Boolean
title String!
description String
body JSON
id ID!
_sys SystemInfo!
_values JSON!

PagesConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [PagesConnectionEdges]

PagesConnectionEdges

Fields

Name	Description
cursor String!
node Pages

Post

Implements

• Node
• Document

Fields

Name	Description
help Boolean
lastmod String
title String!
authors [PostAuthors]
date String!
tags [String]
body JSON
id ID!
_sys SystemInfo!
_values JSON!

PostAuthors

Fields

Name	Description
name String!
title String
url String
image_url String

PostConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [PostConnectionEdges]

PostConnectionEdges

Fields

Name	Description
cursor String!
node Post

Settings

Implements

• Node
• Document

Fields

Name	Description
help Boolean
_warning String
label String!
title String!
tagline String
favicon String
graphql String
colorMode SettingsColorMode
footer SettingsFooter
github SettingsGithub
languages SettingsLanguages
logo SettingsLogo
openapi SettingsOpenapi
prism SettingsPrism
url SettingsUrl
navbar [SettingsNavbar]
sidebarHideable Boolean
showReadingTime Boolean
id ID!
_sys SystemInfo!
_values JSON!

SettingsColorMode

Fields

Name	Description
defaultMode String
disableSwitch Boolean
respectPrefersColorScheme Boolean

SettingsConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [SettingsConnectionEdges]

SettingsConnectionEdges

Fields

Name	Description
cursor String!
node Settings

SettingsFooter

Fields

Name	Description
style String
links [SettingsFooterLinks]
copyright String

SettingsFooterLinks

Fields

Name	Description
title String
items [SettingsFooterLinksItems]

SettingsFooterLinksItemsBlog

Fields

Name	Description
label String

SettingsFooterLinksItemsExternal

Fields

Name	Description
label String
href String

SettingsFooterLinksItemsInternal

Fields

Name	Description
label String
to SettingsFooterLinksItemsInternalTo

SettingsGithub

Fields

Name	Description
projectName String
organizationName String

SettingsLanguages

Fields

Name	Description
supported [SettingsLanguagesSupported]
default String!

SettingsLanguagesSupported

Fields

Name	Description
code String!
label String!

SettingsLogo

Fields

Name	Description
alt String
src String

SettingsNavbar

Fields

Name	Description
label String!
link String
docLink SettingsNavbarDocLink
pageLink SettingsNavbarPageLink
externalLink String
manualPath String
docId String
position String!
items [SettingsNavbarItems]

SettingsNavbarItems

Fields

Name	Description
label String!
link String
docLink SettingsNavbarItemsDocLink
pageLink SettingsNavbarItemsPageLink
externalLink String
manualPath String
docId String
position String!
items [SettingsNavbarItemsItems]

SettingsNavbarItemsItems

Fields

Name	Description
label String!
link String
docLink SettingsNavbarItemsItemsDocLink
pageLink SettingsNavbarItemsItemsPageLink
externalLink String
manualPath String
docId String
position String!

SettingsOpenapi

Fields

Name	Description
apis [SettingsOpenapiApis]
languageTabs [String]

SettingsOpenapiApis

Fields

Name	Description
name String!
specPath String!
outputDir String!
downloadUrl String
groupPathsBy String
categoryLinkSource String

SettingsPrism

Fields

Name	Description
additionalLanguages [String]
magicComments [SettingsPrismMagicComments]
theme String
darkTheme String

SettingsPrismMagicComments

Fields

Name	Description
className String!
line String
block SettingsPrismMagicCommentsBlock

SettingsPrismMagicCommentsBlock

Fields

Name	Description
start String
end String

SettingsUrl

Fields

Name	Description
siteUrl String!
baseUrl String
trailingSlash Boolean

Sidebar

Implements

• Node
• Document

Fields

Name	Description
help Boolean
_warning String
label String!
items [SidebarItems]
id ID!
_sys SystemInfo!
_values JSON!

SidebarConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [SidebarConnectionEdges]

SidebarConnectionEdges

Fields

Name	Description
cursor String!
node Sidebar

SidebarItemsCategory

Fields

Name	Description
title String!
link String
docLink SidebarItemsCategoryDocLink
items [SidebarItemsCategoryItems]

SidebarItemsCategoryItemsCategory

Fields

Name	Description
title String!
link String
docLink SidebarItemsCategoryItemsCategoryDocLink
items [SidebarItemsCategoryItemsCategoryItems]

SidebarItemsCategoryItemsCategoryItemsCategory

Fields

Name	Description
title String!
link String
docLink SidebarItemsCategoryItemsCategoryItemsCategoryDocLink
items [SidebarItemsCategoryItemsCategoryItemsCategoryItems]

SidebarItemsCategoryItemsCategoryItemsCategoryItemsDoc

Fields

Name	Description
document SidebarItemsCategoryItemsCategoryItemsCategoryItemsDocDocument!
label String

SidebarItemsCategoryItemsCategoryItemsCategoryItemsLink

Fields

Name	Description
title String!
href String!

SidebarItemsCategoryItemsCategoryItemsDoc

Fields

Name	Description
document SidebarItemsCategoryItemsCategoryItemsDocDocument!
label String

SidebarItemsCategoryItemsCategoryItemsLink

Fields

Name	Description
title String!
href String!

SidebarItemsCategoryItemsDoc

Fields

Name	Description
document SidebarItemsCategoryItemsDocDocument!
label String

SidebarItemsCategoryItemsLink

Fields

Name	Description
title String!
href String!

SidebarItemsDoc

Fields

Name	Description
document SidebarItemsDocDocument!
label String

SidebarItemsLink

Fields

Name	Description
title String!
href String!

Snippets

Implements

• Node
• Document

Fields

Name	Description
help Boolean
title String!
description String
body JSON
id ID!
_sys SystemInfo!
_values JSON!

SnippetsConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [SnippetsConnectionEdges]

SnippetsConnectionEdges

Fields

Name	Description
cursor String!
node Snippets

SystemInfo

Fields

Name	Description
filename String!
title String
basename String!
hasReferences Boolean
breadcrumbs [String!]!	Arguments Name Description excludeExtension Boolean
path String!
relativePath String!
extension String!
template String!
collection Collection!

Taxonomy

Implements

• Node
• Document

Fields

Name	Description
help Boolean
taxonomy [TaxonomyTaxonomy]
id ID!
_sys SystemInfo!
_values JSON!

TaxonomyConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [TaxonomyConnectionEdges]

TaxonomyConnectionEdges

Fields

Name	Description
cursor String!
node Taxonomy

TaxonomyTaxonomy

Fields

Name	Description
tag String!
children [TaxonomyTaxonomyChildren]

TaxonomyTaxonomyChildren

Fields

Name	Description
tag String!
children [TaxonomyTaxonomyChildrenChildren]

TaxonomyTaxonomyChildrenChildren

Fields

Name	Description
tag String!

Theme

Implements

• Node
• Document

Fields

Name	Description
_warning String
help Boolean
colors ThemeColors
darkColors ThemeDarkColors
typography ThemeTypography
layout ThemeLayout
customCSS String
id ID!
_sys SystemInfo!
_values JSON!

ThemeColors

Fields

Name	Description
primary String
primaryDark String
primaryDarker String
primaryDarkest String
primaryLight String
primaryLighter String
primaryLightest String
footerBackground String
highlightedCodeLineBackground String

ThemeConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [ThemeConnectionEdges]

ThemeConnectionEdges

Fields

Name	Description
cursor String!
node Theme

ThemeDarkColors

Fields

Name	Description
primary String
primaryDark String
primaryDarker String
primaryDarkest String
primaryLight String
primaryLighter String
primaryLightest String
footerBackground String
highlightedCodeLineBackground String

ThemeLayout

Fields

Name	Description
globalRadius Float
buttonRadius Float
cardRadius Float
navbarHeight String

ThemeTypography

Fields

Name	Description
baseFontFamily String
monospaceFontFamily String
codeFontSize String

VariableSets

Implements

• Node
• Document

Fields

Name	Description
help Boolean
variableSets [VariableSetsVariableSets]
id ID!
_sys SystemInfo!
_values JSON!

VariableSetsConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [VariableSetsConnectionEdges]

VariableSetsConnectionEdges

Fields

Name	Description
cursor String!
node VariableSets

VariableSetsVariableSets

Fields

Name	Description
name String!
variables [VariableSetsVariableSetsVariables]

VariableSetsVariableSetsVariables

Fields

Name	Description
key String!
translations [VariableSetsVariableSetsVariablesTranslations]

VariableSetsVariableSetsVariablesTranslations

Fields

Name	Description
lang String!
value String!

Wiki

Implements

• Node
• Document

Fields

Name	Description
help Boolean
lastmod String
title String!
body JSON
id ID!
_sys SystemInfo!
_values JSON!

WikiConnection

Implements

• Connection

Fields

Name	Description
pageInfo PageInfo!
totalCount Float!
edges [WikiConnectionEdges]

WikiConnectionEdges

Fields

Name	Description
cursor String!
node Wiki