getPortalSiteDocument

Topics: Surfaces

Read a site version's source as typed parts (pages, components, routes, tools, libraries, layouts, styles, assets) with the canonical source, or null when the version does not exist. A sibling of getPortalSiteVersion, so the parts never enter IaC state. Fails closed when the stored source no longer passes the current reading rules (it was saved under rules that have since changed): the error carries extensions.code PORTAL_SITE_SOURCE_UNREADABLE, and the snapshot itself is still readable with getPortalSiteVersion.

Returns

PortalSiteDocument

Arguments

Site version whose source to read.

Exact field SDL
"""
Read a site version's source as typed parts (pages, components, routes, tools, libraries, layouts, styles, assets) with the canonical `source`, or null when the version does not exist. A sibling of `getPortalSiteVersion`, so the parts never enter IaC state. Fails closed when the stored source no longer passes the current reading rules (it was saved under rules that have since changed): the error carries `extensions.code` `PORTAL_SITE_SOURCE_UNREADABLE`, and the snapshot itself is still readable with `getPortalSiteVersion`.
"""
getPortalSiteDocument(
  """Site version whose source to read."""
  versionId: PortalSiteVersionID!
): PortalSiteDocument @topic(names: ["surfaces"])

Declared on Query. Access is checked by the platform for each operation.