model

Documentation

Index

• Constants
• Variables
• type Response
  • func ErrorToBadRequestErrorResponse(err error) *Response
  • func ErrorToInternalServerErrorResponse(err error) *Response
  • func (r Response) Send(ctx *fiber.Ctx) error
• type RestrictionKey
  • func NewRestrictionKey(s string) RestrictionKey
  • func (rk RestrictionKey) MarshalJSON() ([]byte, error)
  • func (rk *RestrictionKey) String() string
  • func (rk *RestrictionKey) UnmarshalJSON(data []byte) error
  • func (rk *RestrictionKey) UnmarshalText(data []byte) error
  • func (rk *RestrictionKey) UnmarshalYAML(value *yaml.Node) error
  • func (rk *RestrictionKey) Valid() bool
• type RestrictionKeys
  • func (rks RestrictionKeys) Disable(disable RestrictionKeys) (left RestrictionKeys)
  • func (rks RestrictionKeys) Has(rk RestrictionKey) bool

Constants

const (
	AttrScope      = "scope"
	AttrAud        = "audience"
	AttrCapability = "capability"
)

Defined attributes

Variables

var AllRestrictionKeyStrings = api.AllRestrictionKeys

AllRestrictionKeyStrings holds all defined RestrictionKey strings

var Attributes = []string{
	AttrScope,
	AttrAud,
	AttrCapability,
}

Attributes holds all defined attributes

var ResponseNYI = Response{
	Status:   fiber.StatusNotImplemented,
	Response: api.ErrorNYI,
}

ResponseNYI is the server response when something is not yet implemented

Types

type Response

type Response struct {
	// The Http Status code of the response
	Status int
	// The response body, will be marshalled as json
	Response interface{}
	// Cookies that should be set
	Cookies []*fiber.Cookie
}

Response models a http server response

func ErrorToBadRequestErrorResponse

func ErrorToBadRequestErrorResponse(err error) *Response

ErrorToBadRequestErrorResponse creates a bad request error response from a golang error

func ErrorToInternalServerErrorResponse

func ErrorToInternalServerErrorResponse(err error) *Response

ErrorToInternalServerErrorResponse creates an internal server error response from a golang error

func (Response) Send

func (r Response) Send(ctx *fiber.Ctx) error

Send sends this response using the passed fiber.Ctx

type RestrictionKey

type RestrictionKey int

RestrictionKey is an enum like type for restriction keys

const (
	RestrictionKeyNotBefore RestrictionKey = iota
	RestrictionKeyExpiresAt
	RestrictionKeyScope
	RestrictionKeyAudiences
	RestrictionKeyIPs
	RestrictionKeyGeoIPAllow
	RestrictionKeyGeoIPDisallow
	RestrictionKeyUsagesAT
	RestrictionKeyUsagesOther
)

RestrictionKeys

func NewRestrictionKey

func NewRestrictionKey(s string) RestrictionKey

NewRestrictionKey creates a new RestrictionKey from the grant type string

func (RestrictionKey) MarshalJSON

func (rk RestrictionKey) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface

func (*RestrictionKey) String

func (rk *RestrictionKey) String() string

func (*RestrictionKey) UnmarshalJSON

func (rk *RestrictionKey) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface

func (*RestrictionKey) UnmarshalText

func (rk *RestrictionKey) UnmarshalText(data []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface

func (*RestrictionKey) UnmarshalYAML

func (rk *RestrictionKey) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML implements the yaml.Unmarshaler interface

func (*RestrictionKey) Valid

func (rk *RestrictionKey) Valid() bool

Valid checks that RestrictionKey is a defined grant type

type RestrictionKeys

type RestrictionKeys []RestrictionKey

RestrictionKeys is a slice of RestrictionKey

var AllRestrictionKeys RestrictionKeys

AllRestrictionKeys holds all defined RestrictionKeys

func (RestrictionKeys) Disable

func (rks RestrictionKeys) Disable(disable RestrictionKeys) (left RestrictionKeys)

Disable subtracts the passed RestrictionKeys from this RestrictionKeys and returns the left RestrictionKeys

func (RestrictionKeys) Has

func (rks RestrictionKeys) Has(rk RestrictionKey) bool

Has checks if a a RestrictionKey is in a RestrictionKeys