Profile: image-gallery

Profile Schema

A image-gallery is a document that contains other image 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. These asset links should all be links to documents with the image profile type.

Structure

The image-gallery profile specifies the following attributes:

Name	Type	Required?	Explanation
title	string	No	A human-readable title for this gallery to be displayed.
introText	string	No	Introduction text for the gallery.
shouldImageCaptionsDisplayByDefault	boolean	No	Flag representing whether the captions for the contained images should be displayed by default

Example image-gallery document

{
    "id": "12345",
    "title": "Pictures of Tatooine",
    "introText": "Enjoy the scenic dunes, rocks, and hives of scum and villainy",
    "profiles": [
        {
            "href": "/v1/profiles/image-gallery",
            "rels": [
                "type"
            ]
        },
        {
            "href": "/v1/profiles/container"
        },
        {
            "href": "/v1/profiles/document"
        }
    ],
    "layout": [
        {
            "href": "#/assets/5678"
        }
    ]
}