Profile: resource-container

Profile Schema

A resource-container is a document with size and content descriptors that contains other assets, allowing them to be grouped on the website for editorial or stylistic reasons. This profile requires the container profile, and list of assets will be contained in the layout defined in the container profile.

Structure

The resource-container profile specifies the following attributes:

Name Type Required? Explanation
title string No A human-readable title for this container to be displayed.
introText string No Introduction text for the container.
nprDisplayColumnSpan string No contains information for the display size of the container. This value MUST be one of inset, or fullWidth.

Example container document


{
  "id": "1058111253",
  "title": "Follow Us",
  "introText": "Facebook, Twitter, and Youtube",
  "nprDisplayColumnSpan": "inset",
  "profiles": [
  {
    "href": "/v1/profiles/resource-container",
    "rels": [
      "type"
    ]
  },
  {
    "href": "/v1/profiles/container"
  },
  {
    "href": "/v1/profiles/document"
  }
],
  "layout": [
    {
      "href": "#/assets/5678"
    }
  ],
}


© 2024 npr