package
2.2.5+incompatible
Repository: https://github.com/goadesign/goa.git
Documentation: pkg.go.dev

# Functions

AccessToken defines the attribute used to provide the access token to an endpoint secured with OAuth2.
AccessTokenField is syntactic sugar to define an access token attribute with the "rpc:tag" meta set with the value of the first argument.
API defines a network service API.
APIKey defines the attribute used to provide the API key to an endpoint secured with API keys.
APIKeyField is syntactic sugar to define an API key attribute with the "rpc:tag" meta set with the value of the first argument.
APIKeySecurity defines an API key security scheme where a key must be provided by the client to perform authorization.
ArrayOf creates an array type from its element type.
Attribute describes a field of an object.
Attributes implements the result type Attributes DSL.
AuthorizationCodeFlow defines an authorizationCode OAuth2 flow as described in section 1.3.1 of RFC 6749.
BasicAuthSecurity defines a basic authentication security scheme.
Body describes a HTTP request or response body.
CanonicalMethod sets the name of the service canonical method.
ClientCredentialsFlow defines an clientCredentials OAuth2 flow as described in section 1.3.4 of RFC 6749.
Code sets the Response status code.
CollectionOf creates a collection result type from its element result type.
CONNECT creates a route using the CONNECT HTTP method.
Consumes adds a MIME type to the list of MIME types the APIs supports when accepting requests.
Contact sets the API contact information.
ContentType sets the value of the Content-Type response header.
ConvertTo specifies an external type that instances of the generated struct are converted into.
Cookie identifies a HTTP cookie.
CookieDomain defines the "domain" attribute of a HTTP response cookie.
CookieHTTPOnly initializes the "http-only" attribute of a HTTP response cookie with "HttpOnly".
CookieMaxAge defines the "max-age" attribute of a HTTP response cookie.
CookiePath defines the "path" attribute of a HTTP response cookie.
CookieSecure initializes the "secute" attribute of a HTTP response cookie with "Secure".
CreateFrom specifies an external type that instances of the generated struct can be initialized from.
Default sets the default value for an attribute.
DELETE creates a route using the DELETE HTTP method.
Description sets the expression description.
Docs provides external documentation URLs.
Elem makes it possible to specify validations for array and map values.
Email sets the contact email.
Enum adds a "enum" validation to the attribute.
Error describes a method error return value.
Example provides an example value for a type, a parameter, a header or any attribute.
Extend adds the parameter type attributes to the type using Extend.
Fault qualifies an error type as describing errors due to a server-side fault.
Field is syntactic sugar to define an attribute with the "rpc:tag" meta set with the value of the first argument.
Files defines a endpoint that serves static assets via HTTP.
Format adds a "format" validation to the attribute.
GET defines a route using the GET HTTP method.
GRPC defines gRPC transport specific properties on an API, a service, or a single method.
HEAD creates a route using the HEAD HTTP method.
Header describes a single HTTP header or gRPC metadata header.
Headers describes HTTP request/response or gRPC response headers.
Host defines a server host.
HTTP defines the HTTP transport specific properties of an API, a service or a single method.
ImplicitFlow defines an implicit OAuth2 flow as described in section 1.3.2 of RFC 6749.
JWTSecurity defines an HTTP security scheme where a JWT is passed in the request Authorization header as a bearer token to perform auth.
Key makes it possible to specify validations for map keys.
License sets the API license information.
MapOf creates a map from its key and element types.
MapParams describes the query string parameters in a HTTP request.
Maximum adds a "maximum" validation to the attribute.
MaxLength adds a "maxItems" validation to the attribute.
Message describes a gRPC request or response message.
Meta defines a set of key/value pairs that can be assigned to an object.
Metadata defines a gRPC request metadata.
Method defines a single service method.
Minimum adds a "minimum" validation to the attribute.
MinLength adds a "minItems" validation to the attribute.
MultipartRequest indicates that HTTP requests made to the method use MIME multipart encoding as defined in RFC 2046.
Name sets the contact or license name.
NoSecurity removes the need for an endpoint to perform authorization.
OAuth2Security defines an OAuth2 security scheme.
OPTIONS creates a route using the OPTIONS HTTP method.
Param describes a single HTTP request path or query string parameter.
Params groups a set of Param expressions.
Parent sets the name of the parent service.
Password defines the attribute used to provide the password to an endpoint secured with basic authentication.
PasswordField is syntactic sugar to define a password attribute with the "rpc:tag" meta set with the value of the first argument.
PasswordFlow defines an Resource Owner Password Credentials OAuth2 flow as described in section 1.3.3 of RFC 6749.
PATCH creates a route using the PATCH HTTP method.
Path defines an API or service base path, i.e.
Pattern adds a "pattern" validation to the attribute.
Payload defines the data type of an method input.
POST
POST creates a route using the POST HTTP method.
Produces adds a MIME type to the list of MIME types the APIs supports when writing responses.
PUT creates a route using the PUT HTTP method.
Reference sets a type or result type reference.
Required adds a "required" validation to the attribute.
Response describes a HTTP or a gRPC response.
Result defines the data type of a method output.
ResultType defines a result type used to describe a method response.
Scope has two uses: in JWTSecurity or OAuth2Security it defines a scope supported by the scheme.
Security defines authentication requirements to access a service or a service method.
Server describes a single process listening for client requests.
Service defines a group of remotely accessible methods that are hosted together.
Services sets the list of services implemented by a server.
SkipRequestBodyEncodeDecode prevents Goa from generating the request encoding (client) and decoding (server) code.
SkipResponseBodyEncodeDecode prevents Goa from generating the response encoding (server) and decoding (client) code.
StreamingPayload defines a method that accepts a stream of instances of the given type.
StreamingResult defines a method that streams instances of the given type.
Tag identifies a method result type field and a value.
Temporary qualifies an error type as describing temporary (i.e.
TermsOfService describes the API terms of services or links to them.
Timeout qualifies an error type as describing errors due to timeouts.
Title sets the API title.
Token defines the attribute used to provide the JWT to an endpoint secured via JWT.
TokenField is syntactic sugar to define a JWT token attribute with the "rpc:tag" meta set with the value of the first argument.
TRACE creates a route using the TRACE HTTP method.
Trailers defines gRPC trailers in response metadata.
Type defines a user type.
TypeName makes it possible to set the Go struct name for a type or result type in the generated code.
URI defines a server host URI.
URL sets the contact, license or external documentation URL.
Username defines the attribute used to provide the username to an endpoint secured with basic authentication.
UsernameField is syntactic sugar to define a username attribute with the "rpc:tag" meta set with the value of the first argument.
Value sets the example value.
Variable defines a server host URI variable.
Version specifies the API version.
View has two usages: - when used inside a ResultType DSL function it defines a view for the result type.

# Constants

Any is the type for an arbitrary JSON value (interface{} in Go).
Boolean is the type for a JSON boolean.
Bytes is the type for binary data.
CodeAborted represents the gRPC response code "Aborted".
CodeAlreadyExists represents the gRPC response code "AlreadyExists".
CodeCanceled represents the gRPC response code "Canceled".
CodeDataLoss represents the gRPC response code "DataLoss".
CodeDeadlineExceeded represents the gRPC response code "DeadlineExceeded".
CodeFailedPrecondition represents the gRPC response code "FailedPrecondition".
CodeInternal represents the gRPC response code "Internal".
CodeInvalidArgument represents the gRPC response code "InvalidArgument".
CodeNotFound represents the gRPC response code "NotFound".
CodeOK represents the gRPC response code "OK".
CodeOutOfRange represents the gRPC response code "OutOfRange".
CodePermissionDenied represents the gRPC response code "PermissionDenied".
CodeResourceExhausted represents the gRPC response code "ResourceExhausted".
CodeUnauthenticated represents the gRPC response code "Unauthenticated".
CodeUnavailable represents the gRPC response code "Unavailable".
CodeUnimplemented represents the gRPC response code "Unimplemented".
CodeUnknown represents the gRPC response code "Unknown".
Float32 is the type for a 32-bit floating number.
Float64 is the type for a 64-bit floating number.
FormatCIDR describes RFC4632 and RFC4291 CIDR notation IP address values.
FormatDate describes RFC3339 date values.
FormatDateTime describes RFC3339 date time values.
FormatEmail describes RFC5322 email addresses.
FormatHostname describes RFC1035 Internet hostnames.
FormatIP describes RFC2373 IPv4 or IPv6 address values.
FormatIPv4 describes RFC2373 IPv4 address values.
FormatIPv6 describes RFC2373 IPv6 address values.
FormatJSON describes JSON text.
FormatMAC describes IEEE 802 MAC-48, EUI-48 or EUI-64 MAC address values.
FormatRegexp describes regular expression syntax accepted by RE2.
FormatRFC1123 describes RFC1123 date time values.
FormatURI describes RFC3986 URI values.
FormatUUID describes RFC4122 UUID values.
Int is the type for a signed integer.
Int32 is the type for a signed 32-bit integer.
Int64 is the type for a signed 64-bit integer.
String is the type for a JSON string.
UInt is the type for an unsigned integer.
UInt32 is the type for an unsigned 32-bit integer.
UInt64 is the type for an unsigned 64-bit integer.

# Variables

Empty represents empty values.
ErrorResult is the built-in result type for error responses.
ErrorResultIdentifier is the result type identifier used for error responses.

# Type aliases

Val is an alias for expr.Val.