Profile: buildout

Profile Schema

The buildout profile is used to indicate a document that contains web-renderable content beyond a title; if a document fits this description, it is “built out” and can have the buildout profile.

Structure

A document is “built out” if it fits one of the following constraints:

• It implements a “built out” profile (see list below) OR
• It has a non-empty layout array

For more information on the layout array, see the documentation for the renderable profile.

Built out profiles

If the document lists one or more of the following profiles, it is considered “built out”:

• blog
• series
• collection
• topic
• podcast-category
• podcast-channel
• biography
• program

Layout array

If the document has a non-empty layout array, the array must follow the following constraints:

• layout can only contain document-relative asset links (ex: #/assets/1111)
• The links in layout can only have the optional rel values of zone-topareastories, footer, subnav, alt, or rail

Example buildout document

{
  "id": "12345",
  "profiles": [
    {
      "href": "/v1/profiles/buildout"
    },
    {
      "href": "/v1/profiles/document"
    }
  ],

  "assets": {
    "5678": {
      "id": "5678",
      "profiles": [
        {
          "href": "/v1/profiles/text"
        },
        {
          "href": "/v1/profiles/document"
        }
      ],

      "text": "Musings from the Australian Philosophy Department: Part 1"
    }
  }

  "layout": [
    {
      "href": "#/assets/5678"
    }
  ]
}