api

package

v0.7.0 Latest Latest Go to latest Published: May 3, 2021 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jake-hansen/agora

Links

Open Source Insights

Documentation ¶

Index ¶

func SimpleValidationErrors(verr validator.ValidationErrors) map[string]string
type APIError
- func NewAPIError(status int, err error, message string) *APIError
- func (e *APIError) Error() string
- func (e *APIError) Unwrap() error
type ValidationError
- func DescriptiveValidationErrors(verr validator.ValidationErrors) []ValidationError

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func SimpleValidationErrors ¶

func SimpleValidationErrors(verr validator.ValidationErrors) map[string]string

SimpleValidationErrors returns a string map formatted in a descriptive way based on the given validator.ValidationErrors.

Types ¶

type APIError ¶

type APIError struct {
	Status  int    // HTTP status returned to client.
	Err     error  // Error that occurred.
	Message string // Additional information about error returned to client.

}

APIError represents an error that occurred during an operation on an endpoint.

func NewAPIError ¶

func NewAPIError(status int, err error, message string) *APIError

NewAPIError creates a new APIError with the given status, error, and message.

func (*APIError) Error ¶

func (e *APIError) Error() string

Error returns a string representation of the APIError.

func (*APIError) Unwrap ¶

func (e *APIError) Unwrap() error

Unwrap returns the underlying error that caused the APIError.

type ValidationError ¶

type ValidationError struct {
	Field  string `json:"field"`
	Reason string `json:"reason"`
}

ValidationError represents an error that was caused by an invalid request.

func DescriptiveValidationErrors ¶

func DescriptiveValidationErrors(verr validator.ValidationErrors) []ValidationError

DescriptiveValidationErrors returns a slice of ValidationErrors formatted in a descriptive way based on the given validator.ValidationErrors.

Source Files ¶

View all Source files

apierrors.go

Directories ¶

Path	Synopsis
dto
handlers
authhandler
healthhandler
invitehandler
meetinghandler
meetingplatformhandler
userhandler
middleware
authmiddleware
corsmiddleware
validator

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