design

Documentation

Index

• Variables

Variables

var Account = Type("Account", func() {
	Attribute("id", Int64, "Temporary account identifier", func() {
		Meta("struct:tag:json", "id,omitempty")
		Meta("struct:tag:gorm", "autoIncrement")
	})
	Attribute("guid", String, "IDP account identifier", func() {
		Meta("struct:tag:json", "guid,omitempty")
	})
	Attribute("name", String, "Name of user", func() {
		Example("Amos Burton")
	})
	Attribute("login", String, "Login of user", func() {
		Example("amos")
		Meta("struct:tag:json", "login")
		Meta("struct:tag:gorm", "uniqueIndex")
	})
	Attribute("email", String, "Email of user", func() {
		Example("amos@hostedzonehere.com")
	})
	Attribute("status", String, "Status of account", func() {
		Enum("active", "disabled", "pending")
	})
	Required("name", "login", "email")
})

var BasicAuth = BasicAuthSecurity("BasicAuth", func() {
	Description("Use client ID and client secret to authenticate")
})

var CreateAccount = Type("CreateAccount", func() {
	Attribute("name", String, "Name of user", func() {
		Example("Amos Burton")
	})
	Attribute("login", String, "Login of user", func() {
		Example("amos")
	})
	Attribute("email", String, "Email of user", func() {
		Example("amos@hostedzonehere.com")
	})
	Required("name", "login", "email")
})

var Group = Type("group", func() {
	Attribute("name", String, "Name of group", func() {
		Example("GROUPNAME")
	})
	Attribute("id", String, "ID of group", func() {
		Example("example 1", "6dfb5ec6-0c8e-4efa-ae7d-9eca77b73d2b")
		Example("another 2", "ac32dcb3-3a58-4bfc-b801-6609681ec712")
	})
})

var UpdateAccount = Type("UpdateAccount", func() {
	Attribute("status", String, "Status of user", func() {
		Enum("active", "disabled", "pending")
	})
	Required("status")
})