Module Values.VisualReferenceInputSource

An object that specifies what screenshots to use as a baseline for visual monitoring by this canary. It can optionally also specify parts of the screenshots to ignore during the visual monitoring comparison. Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

Sourcetype nonrec t = {
  1. baseScreenshots : BaseScreenshots.t option;
    (*

    An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for visual monitoring, remove it from this array.

    *)
  2. baseCanaryRunId : String_.t;
    (*

    Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are nextrun to use the screenshots from the next run after this update is made, lastrun to use the screenshots from the most recent run before this update was made, or the value of Id in the CanaryRun from a run of this a canary in the past 31 days. If you specify the Id of a canary run older than 31 days, the operation returns a 400 validation exception error..

    *)
  3. browserType : BrowserType.t option;
    (*

    The browser type associated with this visual reference.

    *)
}
Sourceval context_ : string
Sourceval make : ?baseScreenshots:??? -> ?browserType:??? -> baseCanaryRunId:String_.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `List of [> `String of BaseScreenshotConfigIgnoreCoordinate.t ] list | `String of String_.t ]) list ] list | `String of String_.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t