design

Documentation

Index

• Variables

Variables

var RawPayload = Type("RawPayload", func() {
	Attribute("check_id", UUID, "Check UUID")
	Attribute("scan_id", UUID, "Scan UUID")
	Attribute("scan_start_time", DateTime, "Scan start time")
	Attribute("raw", String, func() {
		Example(`{ raw : "BASE_64_FORMAT" }`)
		Description("Raw result of a Check. It's a JSON with a BASE64 encoded value of the raw result")
	})
})

var ReportPayload = Type("ReportPayload", func() {
	Attribute("check_id", UUID, "Check UUID")
	Attribute("scan_id", UUID, "Scan UUID")
	Attribute("scan_start_time", DateTime, "Scan start time")
	Attribute("report", String, func() {
		MinLength(2)
		Example(`{ report : "{"report":"{\"check_id\":\"aabbccdd-abcd-0123-4567-abcdef012345\", .....}}" }`)
		Pattern("^[[:print:]]+")
		Description("Report of a Check. It's a JSON containing the value of the report")
	})
})