design

Documentation

Index

• Variables

Variables

var NotFound = Type("NotFound", func() {
	Description("NotFound is the type returned when the requested data that does not exist.")
	Attribute("message", String, "Message of error", func() {
		Example("Client ABCDEF12356890 not found")
	})
	Field(2, "id", String, "ID of missing data")
	Required("message", "id")
})

var UserResult = ResultType("application/vnd.user", func() {
	Description("User type")
	TypeName("User")
	Field(1, "Id", func() {
		Example("1")
	})
	Field(2, "Email", func() {
		Example("john.doe@example.com")
	})
	Field(3, "FirstName", func() {
		Example("John")
	})
	Field(4, "LastName", func() {
		Example("Doe")
	})
})