design

package
v1.1.2-beta Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 18, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var CreateUserPayload = Type("CreateUserPayload", func() {
	Description("CreateUserPayload")

	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("organizations", ArrayOf(String), "List of organizations to which this user belongs to")
	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("token", String, "Token for email verification")

	Required("email")
})

CreateUserPayload defines the payload for the user.

View Source
var CredentialsPayload = Type("Credentials", func() {
	Description("Email and password credentials")
	Attribute("email", String, "Email of user", func() {
		Format("email")
	})
	Attribute("password", String, "Password of user", func() {
		MinLength(6)
		MaxLength(30)
	})
	Required("email", "password")
})

CredentialsPayload defines the payload for the credentials.

View Source
var EmailPayload = Type("EmailPayload", func() {
	Description("Email payload")
	Attribute("email", String, "Email of user", func() {
		Format("email")
	})
	Required("email")
})

EmailPayload defines the payload for the email.

View Source
var ForgotPasswordPayload = Type("ForgotPasswordPayload", func() {
	Description("Password Reset payload")
	Attribute("email", String, "Email of the user", func() {
		Format("email")
	})
	Attribute("password", String, "New password", func() {
		MinLength(6)
		MaxLength(30)
	})
	Attribute("token", String, "Forgot password token")
	Required("email", "password", "token")
})

ForgotPasswordPayload defines the payload for the password/forgot.

View Source
var ResetTokenMedia = MediaType("ResetTokenMedia", func() {
	TypeName("ResetToken")
	Attributes(func() {
		Attribute("id", String, "User ID")
		Attribute("email", String, "User email")
		Attribute("token", String, "New token")
		Required("id", "email", "token")
	})
	View("default", func() {
		Attribute("id")
		Attribute("email")
		Attribute("token")
	})
})

ResetTokenMedia is returned after successful reset of the verification token

View Source
var UpdateUserPayload = Type("UpdateUserPayload", func() {
	Description("UpdateUserPayload")

	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("organizations", ArrayOf(String), "List of organizations to which this user belongs to")
	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("token", String, "Token for email verification")
})

UpdateUserPayload defines the payload for the user.

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

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

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

UserMedia defines the media type used to render user.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL