design

Documentation

Index

• Variables

Variables

var ResendVerificationPayload = Type("ResendVerificationPayload", func() {
	Description("Payload for resending email verification. Contains user email")
	Attribute("email", String, "User email for verification")
	Required("email")
})

ResendVerificationPayload contains the email for the user to reset verification.

var UserMedia = MediaType("application/vnd.goa.user+json", func() {
	TypeName("users")
	Reference(UserPayload)

	Attributes(func() {
		Attribute("id", String, "Unique user ID")
		Attribute("fullname")
		Attribute("email")
		Attribute("roles")
		Attribute("externalId")
		Attribute("active")
		Required("id", "fullname", "email", "roles", "externalId", "active")
	})

	View("default", func() {
		Attribute("id")
		Attribute("fullname")
		Attribute("email")
		Attribute("roles")
		Attribute("externalId")
		Attribute("active")
	})
})

UserMedia defines the media type used to render user.

var UserPayload = Type("UserPayload", func() {
	Description("UserPayload")

	Attribute("fullname", String, "Full name of user", func() {
		Pattern("^([a-zA-Z0-9 ]{4,30})$")
	})
	Attribute("email", String, "Email of user", func() {
		Format("email")
	})
	Attribute("password", String, "Password of user", func() {
		MinLength(6)
		MaxLength(30)
	})
	Attribute("roles", ArrayOf(String), "Roles of user")
	Attribute("namespaces", ArrayOf(String), "List of namespaces this user belongs to")
	Attribute("externalId", String, "External id of user")
	Attribute("active", Boolean, "Status of user account", func() {
		Default(false)
	})
	Attribute("sendActivationMail", Boolean, "Status of user account", func() {
		Default(true)
	})
	Attribute("token", String, "Email verification token")

	Required("fullname", "email")
})

UserPayload defines the payload for the user.