NamingConventionAtom

An atom that can be placed in an organization's naming convention template.

type NamingConventionAtom {
  token: String!
  label: String!
  description: String!
  example: String!
  category: NamingConventionAtomCategory!
  guaranteesUniqueName: Boolean!
}

Fields

NamingConventionAtom.token ● String! non-null scalar {#token}

The Liquid token to insert, for example {{instance.id}}.

NamingConventionAtom.label ● String! non-null scalar {#label}

A short human label for the atom.

NamingConventionAtom.description ● String! non-null scalar {#description}

What the atom renders to.

NamingConventionAtom.example ● String! non-null scalar {#example}

An example rendered value.

NamingConventionAtom.category ● NamingConventionAtomCategory! non-null enum {#category}

The group the atom belongs to.

NamingConventionAtom.guaranteesUniqueName ● Boolean! non-null scalar {#guarantees-unique-name}

True when using this atom alone makes every instance's name unique within the organization.

Returned By

namingConventionAtoms query