{ "$schema": "http://json-schema.org/draft-07/schema", "$id": "banner-schema", "type": "object", "title": "The root schema", "description": "The root schema comprises the entire JSON document.", "properties": { "_id": { "$ref": "common-schema#/definitions/objectId" }, "active": { "type": "boolean", "description": "A flag indicating if the banner will be displayed to users" }, "text": { "type": "string", "description": "Text in the banner when displayed" }, "backgroundColor": { "type": "string", "description": "The background color for the banner displayed", "examples": [ "#fff" ] }, "dismissible": { "type": "boolean", "description": "A flag indicating if a banner should be dismissible by users" }, "startTime": { "type": "string", "description": "An ISO Timestring value indicating when the banner will show", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", "examples": [ "2018-08-02T15:56:12.912Z" ] }, "endTime": { "type": "string", "description": "A, ISO Timestring value indicating when the banner will no longer show", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", "examples": [ "2018-08-02T15:56:12.912Z" ] }, "allPages": { "type": "boolean", "description": "A flag indicating if the banner should show on all pages or only the IAP home page" }, "image": { "description": "A base64 image string containing the image that will be shown on the banner", "type": "string" }, "messageLastUpdated": { "type": "string", "description": "An ISO Timestring value indicating when the banner message was last updated", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", "examples": [ "2018-08-02T15:56:12.912Z" ] } }, "required": [ "text", "active", "startTime", "dismissible", "allPages" ], "definitions": {} }
2023.2 (latest)