design

Documentation

Index

• Variables

Variables

var CityAndState = Type("CityAndState", func() {
	Description("Location city and state.")
	Attribute("state", String, "State", func() {
		Example("CA")
		MinLength(2)
		MaxLength(2)
	})
	Attribute("city", String, "City", func() {
		Example("Santa Barbara")
	})
	Required("city", "state")
})

var Job = Type("Job", func() {
	Description("Location forecast poll job")
	Attribute("key", String, "Job key", func() {
		Example("1")
	})
	Attribute("payload", Bytes, "Job payload", func() {
		Example([]byte(`{"state":"CA","city":"Santa Barbara"}`))
	})
	Attribute("created_at", String, "Creation timestamp", func() {
		Example("2020-09-01T12:00:00Z")
	})
	Required("key", "payload", "created_at")
})

var PollerStatus = Type("PollerStatus", func() {
	Description("Poller status")
	Attribute("workers", ArrayOf(Worker), "Poller workers")
	Attribute("jobs", ArrayOf(Job), "Location poll jobs")
	Required("workers", "jobs")
})

var Worker = Type("Worker", func() {
	Description("Poller worker")
	Attribute("id", String, "Worker ID", func() {
		Example("1")
	})
	Attribute("jobs", ArrayOf(Job), "Worker poll jobs")
	Attribute("created_at", String, "Creation timestamp", func() {
		Example("2020-09-01T12:00:00Z")
	})
	Required("id", "jobs", "created_at")
})