design

Documentation

Index

• Variables

Variables

var BasicAuth = BasicAuthSecurity("basic", func() {
	Description("Secures the login endpoint.")
})

BasicAuth defines a security scheme that uses basic authentication.

var ChatSummary = ResultType("application/vnd.goa.summary", func() {
	TypeName("ChatSummary")
	Attributes(func() {
		Field(1, "message", String, "Message sent to the server")
		Field(2, "length", Int, "Length of the message sent")
		Field(3, "sent_at", String, "Time at which the message was sent", func() {
			Format(FormatDateTime)
		})
		Required("message", "sent_at")
	})
	View("tiny", func() {
		Attribute("message")
	})
})

var Event = Type("Event", func() {
	Field(1, "message", String, "Message sent to the server")
	Field(2, "action", String, func() {
		Enum("added")
	})
	Field(3, "added_at", String, "Time at which the message was added", func() {
		Format(FormatDateTime)
	})
	Required("message", "action", "added_at")
})

var JWTAuth = JWTSecurity("jwt", func() {
	Description(`Secures endpoint by requiring a valid JWT token. Supports scopes "stream:read" and "stream:write".`)
	Scope("stream:read", "Read-only access")
	Scope("stream:write", "Read and write access")
})

JWTAuth defines a security scheme that uses JWT tokens.