Site

Configures a site. A site is a collection of templates that is published to a single domain.

If the conditions in the “If” tab are respected, then the conditions in the “Then” tab should be respected. Otherwise, the conditions in the “Else” tab should be respected.

Must not be:

Type: object

object

The following properties are required:

  • targetRepoName
Type: object

The following properties are required:

  • domain

$idstring Required

Must be at least 1 characters long

Must be at most 64 characters long

$schemaconst Required

Specific value: "https://schema.yext.com/config/pages/site-config/v1"

siteNamestring Required

The name of the site. Must be unique within the account.

Must be at least 1 characters long

Must be at most 50 characters long

repoConfigobject

string

An optional parameter specifying the name of the target repo. If not specified, the domain name is used as the repo name.

string

The Github template repo which holds the template files for the site

domainstring

The ID of the site’s domain configuration.

publishingConfigobject

The configuration used to publish the site’s repository, if it exists.

string Required

The name of the branch to which the staging site should be pinned.

string Required

The name of the branch to which the production site should be pinned.

object Required

The credentials used for access to the staging site.

string Required

string Required

featuresarray Required

Each item of this array must be:

Type: object

A feature of a site.

enum (of string) Required

The feature’s type.

Must be one of:

  • “SELF_SERVE_PAGE_SET”

string Required

The feature’s ref.

attributesarray

Each item of this array must be:

Type: object

An attribute of a site.

string Required

The key of an attribute.

Must be at least 1 characters long

string Required

The name of an attribute.

string Required

The value of an attribute.

string Required

The description of an attribute.

string Required

The locale of an attribute.

enum (of string) Required

The type of an attribute.

Must be one of:

  • “TEXT”
  • “COLOR”
  • “IMAGE”