Profile: area

Profile Schema

A area is a document that contains other layout assets for sequential display. This profile requires the container profile, and a list of assets will be contained in the layout defined in the container profile.

Structure

The area profile specifies the following attributes:

Name	Type	Required?	Explanation
areaType	string	Yes	A descriptor for the semantic purpose of the Area. Accepted values are feature, navigation, zone, supplementary, or overflow.

Example area document

{
    "id": "12345",
    "areaType": "featured",
    "profiles": [
        {
            "href": "/v1/profiles/area",
            "rels": [
                "type"
            ]
        },
        {
            "href": "/v1/profiles/container"
        },
        {
            "href": "/v1/profiles/document"
        }
    ],
    "layout": [
        {
            "href": "#/assets/5678"
        }
    ],
}