server

package
v0.0.0-...-b9360c4 Latest Latest
Warning

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

 Go to latest Published: Dec 15, 2023 License: BSD-3-Clause Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AuthenticateDiscoursePath 

func AuthenticateDiscoursePath() string

AuthenticateDiscoursePath returns the URL path to the discourse service authenticate HTTP endpoint.

func DecodeAuthenticateRequest 

func DecodeAuthenticateRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (interface{}, error)

DecodeAuthenticateRequest returns a decoder for requests sent to the discourse authenticate endpoint.

func EncodeAuthenticateError 

func EncodeAuthenticateError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeAuthenticateError returns an encoder for errors returned by the authenticate discourse endpoint.

func EncodeAuthenticateResponse 

func EncodeAuthenticateResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error

EncodeAuthenticateResponse returns an encoder for responses returned by the discourse authenticate endpoint.

func Mount 

func Mount(mux goahttp.Muxer, h *Server)

Mount configures the mux to serve the discourse endpoints.

func MountAuthenticateHandler 

func MountAuthenticateHandler(mux goahttp.Muxer, h http.Handler)

MountAuthenticateHandler configures the mux to serve the "discourse" service "authenticate" endpoint.

func MountCORSHandler 

func MountCORSHandler(mux goahttp.Muxer, h http.Handler)

MountCORSHandler configures the mux to serve the CORS endpoints for the service discourse.

func NewAuthenticateHandler 

func NewAuthenticateHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(err error) goahttp.Statuser,
) http.Handler

NewAuthenticateHandler creates a HTTP handler which loads the HTTP request and calls the "discourse" service "authenticate" endpoint.

func NewAuthenticatePayload 

func NewAuthenticatePayload(body *AuthenticateRequestBody, token *string) *discourse.AuthenticatePayload

NewAuthenticatePayload builds a discourse service authenticate endpoint payload.

func NewCORSHandler 

func NewCORSHandler() http.Handler

NewCORSHandler creates a HTTP handler which returns a simple 200 response.

func ValidateAuthenticateRequestBody 

func ValidateAuthenticateRequestBody(body *AuthenticateRequestBody) (err error)

ValidateAuthenticateRequestBody runs the validations defined on AuthenticateRequestBody

Types

type AuthenticateBadRequestResponseBody 

type AuthenticateBadRequestResponseBody struct {
	// Name is the name of this class of errors.
	Name string `form:"name" json:"name" xml:"name"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID string `form:"id" json:"id" xml:"id"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message string `form:"message" json:"message" xml:"message"`
	// Is the error temporary?
	Temporary bool `form:"temporary" json:"temporary" xml:"temporary"`
	// Is the error a timeout?
	Timeout bool `form:"timeout" json:"timeout" xml:"timeout"`
	// Is the error a server-side fault?
	Fault bool `form:"fault" json:"fault" xml:"fault"`
}

AuthenticateBadRequestResponseBody is the type of the "discourse" service "authenticate" endpoint HTTP response body for the "bad-request" error.

func NewAuthenticateBadRequestResponseBody 

func NewAuthenticateBadRequestResponseBody(res *goa.ServiceError) *AuthenticateBadRequestResponseBody

NewAuthenticateBadRequestResponseBody builds the HTTP response body from the result of the "authenticate" endpoint of the "discourse" service.

type AuthenticateForbiddenResponseBody 

type AuthenticateForbiddenResponseBody struct {
	// Name is the name of this class of errors.
	Name string `form:"name" json:"name" xml:"name"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID string `form:"id" json:"id" xml:"id"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message string `form:"message" json:"message" xml:"message"`
	// Is the error temporary?
	Temporary bool `form:"temporary" json:"temporary" xml:"temporary"`
	// Is the error a timeout?
	Timeout bool `form:"timeout" json:"timeout" xml:"timeout"`
	// Is the error a server-side fault?
	Fault bool `form:"fault" json:"fault" xml:"fault"`
}

AuthenticateForbiddenResponseBody is the type of the "discourse" service "authenticate" endpoint HTTP response body for the "forbidden" error.

func NewAuthenticateForbiddenResponseBody 

func NewAuthenticateForbiddenResponseBody(res *goa.ServiceError) *AuthenticateForbiddenResponseBody

NewAuthenticateForbiddenResponseBody builds the HTTP response body from the result of the "authenticate" endpoint of the "discourse" service.

type AuthenticateNotFoundResponseBody 

type AuthenticateNotFoundResponseBody struct {
	// Name is the name of this class of errors.
	Name string `form:"name" json:"name" xml:"name"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID string `form:"id" json:"id" xml:"id"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message string `form:"message" json:"message" xml:"message"`
	// Is the error temporary?
	Temporary bool `form:"temporary" json:"temporary" xml:"temporary"`
	// Is the error a timeout?
	Timeout bool `form:"timeout" json:"timeout" xml:"timeout"`
	// Is the error a server-side fault?
	Fault bool `form:"fault" json:"fault" xml:"fault"`
}

AuthenticateNotFoundResponseBody is the type of the "discourse" service "authenticate" endpoint HTTP response body for the "not-found" error.

func NewAuthenticateNotFoundResponseBody 

func NewAuthenticateNotFoundResponseBody(res *goa.ServiceError) *AuthenticateNotFoundResponseBody

NewAuthenticateNotFoundResponseBody builds the HTTP response body from the result of the "authenticate" endpoint of the "discourse" service.

type AuthenticateRequestBody 

type AuthenticateRequestBody struct {
	Sso      *string `form:"sso,omitempty" json:"sso,omitempty" xml:"sso,omitempty"`
	Sig      *string `form:"sig,omitempty" json:"sig,omitempty" xml:"sig,omitempty"`
	Email    *string `form:"email,omitempty" json:"email,omitempty" xml:"email,omitempty"`
	Password *string `form:"password,omitempty" json:"password,omitempty" xml:"password,omitempty"`
}

AuthenticateRequestBody is the type of the "discourse" service "authenticate" endpoint HTTP request body.

type AuthenticateResponseBody 

type AuthenticateResponseBody struct {
	Location string `form:"location" json:"location" xml:"location"`
	Token    string `form:"token" json:"token" xml:"token"`
	Header   string `form:"header" json:"header" xml:"header"`
}

AuthenticateResponseBody is the type of the "discourse" service "authenticate" endpoint HTTP response body.

func NewAuthenticateResponseBody 

func NewAuthenticateResponseBody(res *discourse.AuthenticateResult) *AuthenticateResponseBody

NewAuthenticateResponseBody builds the HTTP response body from the result of the "authenticate" endpoint of the "discourse" service.

type AuthenticateUnauthorizedResponseBody 

type AuthenticateUnauthorizedResponseBody struct {
	// Name is the name of this class of errors.
	Name string `form:"name" json:"name" xml:"name"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID string `form:"id" json:"id" xml:"id"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message string `form:"message" json:"message" xml:"message"`
	// Is the error temporary?
	Temporary bool `form:"temporary" json:"temporary" xml:"temporary"`
	// Is the error a timeout?
	Timeout bool `form:"timeout" json:"timeout" xml:"timeout"`
	// Is the error a server-side fault?
	Fault bool `form:"fault" json:"fault" xml:"fault"`
}

AuthenticateUnauthorizedResponseBody is the type of the "discourse" service "authenticate" endpoint HTTP response body for the "unauthorized" error.

func NewAuthenticateUnauthorizedResponseBody 

func NewAuthenticateUnauthorizedResponseBody(res *goa.ServiceError) *AuthenticateUnauthorizedResponseBody

NewAuthenticateUnauthorizedResponseBody builds the HTTP response body from the result of the "authenticate" endpoint of the "discourse" service.

type AuthenticateUserUnverifiedResponseBody 

type AuthenticateUserUnverifiedResponseBody struct {
	// Name is the name of this class of errors.
	Name string `form:"name" json:"name" xml:"name"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID string `form:"id" json:"id" xml:"id"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message string `form:"message" json:"message" xml:"message"`
	// Is the error temporary?
	Temporary bool `form:"temporary" json:"temporary" xml:"temporary"`
	// Is the error a timeout?
	Timeout bool `form:"timeout" json:"timeout" xml:"timeout"`
	// Is the error a server-side fault?
	Fault bool `form:"fault" json:"fault" xml:"fault"`
}

AuthenticateUserUnverifiedResponseBody is the type of the "discourse" service "authenticate" endpoint HTTP response body for the "user-unverified" error.

func NewAuthenticateUserUnverifiedResponseBody 

func NewAuthenticateUserUnverifiedResponseBody(res *goa.ServiceError) *AuthenticateUserUnverifiedResponseBody

NewAuthenticateUserUnverifiedResponseBody builds the HTTP response body from the result of the "authenticate" endpoint of the "discourse" service.

type ErrorNamer 

type ErrorNamer interface {
	ErrorName() string
}

ErrorNamer is an interface implemented by generated error structs that exposes the name of the error as defined in the design.

type MountPoint 

type MountPoint struct {
	// Method is the name of the service method served by the mounted HTTP handler.
	Method string
	// Verb is the HTTP method used to match requests to the mounted handler.
	Verb string
	// Pattern is the HTTP request path pattern used to match requests to the
	// mounted handler.
	Pattern string
}

MountPoint holds information about the mounted endpoints.

type Server 

type Server struct {
	Mounts       []*MountPoint
	Authenticate http.Handler
	CORS         http.Handler
}

Server lists the discourse service endpoint HTTP handlers.

func New 

func New(
	e *discourse.Endpoints,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(err error) goahttp.Statuser,
) *Server

New instantiates HTTP handlers for all the discourse service endpoints using the provided encoder and decoder. The handlers are mounted on the given mux using the HTTP verb and path defined in the design. errhandler is called whenever a response fails to be encoded. formatter is used to format errors returned by the service methods prior to encoding. Both errhandler and formatter are optional and can be nil.

func (*Server) Service 

func (s *Server) Service() string

Service returns the name of the service served.

func (*Server) Use 

func (s *Server) Use(m func(http.Handler) http.Handler)

Use wraps the server handlers with the given middleware.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.