Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

types

package

Go to main page

Versions in this module

v0

v0.5.2

Feb 11, 2025

Changes in this version

type AccessControl

+ CanPatch func(apiOp *APIRequest, obj APIObject, schema *APISchema) error

v0.5.1

Nov 14, 2024

v0.5.0

Nov 14, 2024

v0.4.1

Nov 15, 2024

v0.4.0

Oct 9, 2024

v0.3.0

Nov 15, 2024

v0.2.0

Nov 15, 2024

v0.1.0

Nov 15, 2024

Changes in this version

+ var ChangeAPIEvent = "resource.change"

+ var CreateAPIEvent = "resource.create"

+ var RemoveAPIEvent = "resource.remove"

+ var ReservedFields = map[string]bool

+ func APIChan(c <-chan APIEvent, f func(APIObject) APIObject) chan APIEvent

+ func JSONEncoder(writer io.Writer, v interface{}) error

+ func JSONLinesEncoder(writer io.Writer, v interface{}) error

+ func Name(d map[string]interface{}) string

+ func Namespace(d map[string]interface{}) string

+ func YAMLEncoder(writer io.Writer, v interface{}) error

+ type APIEvent struct

+ Data interface{}

+ Error error

+ ID string

+ Name string

+ Namespace string

+ Object APIObject

+ ResourceType string

+ Revision string

+ Selector string

+ type APIObject struct

+ ID string

+ Object interface{}

+ Type string

+ Warnings []Warning

+ func DefaultByID(store Store, apiOp *APIRequest, schema *APISchema, id string) (APIObject, error)

+ func (a *APIObject) Data() data.Object

+ func (a *APIObject) Name() string

+ func (a *APIObject) Namespace() string

+ type APIObjectList struct

+ Continue string

+ Count int

+ Objects []APIObject

+ Pages int

+ Revision string

+ Warnings []Warning

+ type APIRequest struct

+ AccessControl AccessControl

+ Action string

+ ErrorHandler ErrorHandler

+ Link string

+ Method string

+ Name string

+ Namespace string

+ Query url.Values

+ Request *http.Request

+ Response http.ResponseWriter

+ ResponseFormat string

+ ResponseWriter ResponseWriter

+ Schema *APISchema

+ Schemas *APISchemas

+ Type string

+ URLBuilder URLBuilder

+ URLPrefix string

+ func GetAPIContext(ctx context.Context) *APIRequest

+ func StoreAPIContext(apiOp *APIRequest) *APIRequest

+ func (r *APIRequest) Clone() *APIRequest

+ func (r *APIRequest) Context() context.Context

+ func (r *APIRequest) GetUser() string

+ func (r *APIRequest) GetUserInfo() (user.Info, bool)

+ func (r *APIRequest) Option(key string) string

+ func (r *APIRequest) WithContext(ctx context.Context) *APIRequest

+ func (r *APIRequest) WriteError(err error)

+ func (r *APIRequest) WriteResponse(code int, obj APIObject)

+ func (r *APIRequest) WriteResponseList(code int, list APIObjectList)

+ type APISchema struct

+ ActionHandlers map[string]http.Handler

+ ByIDHandler RequestHandler

+ CollectionFormatter CollectionFormatter

+ CreateHandler RequestHandler

+ DeleteHandler RequestHandler

+ ErrorHandler ErrorHandler

+ Formatter Formatter

+ LinkHandlers map[string]http.Handler

+ ListHandler RequestListHandler

+ RequestModifier RequestModifier

+ Store Store

+ UpdateHandler RequestHandler

+ func (a *APISchema) DeepCopy() *APISchema

+ type APISchemas struct

+ Attributes map[string]interface{}

+ InternalSchemas *schemas.Schemas

+ Schemas map[string]*APISchema

+ func EmptyAPISchemas() *APISchemas

+ func (a *APISchemas) AddSchema(schema APISchema) error

+ func (a *APISchemas) AddSchemas(schema *APISchemas) error

+ func (a *APISchemas) Import(obj interface{}) (*APISchema, error)

+ func (a *APISchemas) LookupSchema(name string) *APISchema

+ func (a *APISchemas) MustAddSchema(obj APISchema) *APISchemas

+ func (a *APISchemas) MustAddSchemas(schemas *APISchemas) *APISchemas

+ func (a *APISchemas) MustImportAndCustomize(obj interface{}, f func(*APISchema))

+ func (a *APISchemas) ShallowCopy() *APISchemas

+ type AccessControl interface

+ CanAction func(apiOp *APIRequest, schema *APISchema, name string) error

+ CanCreate func(apiOp *APIRequest, schema *APISchema) error

+ CanDelete func(apiOp *APIRequest, obj APIObject, schema *APISchema) error

+ CanDo func(apiOp *APIRequest, resource, verb, namespace, name string) error

+ CanGet func(apiOp *APIRequest, schema *APISchema) error

+ CanList func(apiOp *APIRequest, schema *APISchema) error

+ CanUpdate func(apiOp *APIRequest, obj APIObject, schema *APISchema) error

+ CanWatch func(apiOp *APIRequest, schema *APISchema) error

+ type Collection struct

+ Actions map[string]string

+ Continue string

+ Count int

+ CreateTypes map[string]string

+ Links map[string]string

+ Pages int

+ Pagination *Pagination

+ ResourceType string

+ Revision string

+ Type string

+ func (c *Collection) AddAction(apiOp *APIRequest, name string)

+ type CollectionFormatter func(request *APIRequest, collection *GenericCollection)

+ type Condition struct

+ Modifier ModifierType

+ Value interface{}

+ type ErrorHandler func(request *APIRequest, err error)

+ type Formatter func(request *APIRequest, resource *RawResource)

+ func FormatterChain(formatter Formatter, next Formatter) Formatter

+ type GenericCollection struct

+ Data []*RawResource

+ type ModifierType string

+ var ModifierEQ ModifierType = "eq"

+ var ModifierIn ModifierType = "in"

+ var ModifierNE ModifierType = "ne"

+ var ModifierNotIn ModifierType = "notin"

+ var ModifierNotNull ModifierType = "notnull"

+ var ModifierNull ModifierType = "null"

+ type NamedResource struct

+ Description string

+ Name string

+ type NamedResourceCollection struct

+ Data []NamedResource

+ type Pagination struct

+ First string

+ Limit int

+ Next string

+ Partial bool

+ type RawResource struct

+ APIObject APIObject

+ ActionLinks bool

+ Actions map[string]string

+ ID string

+ Links map[string]string

+ Schema *APISchema

+ Type string

+ func (r *RawResource) AddAction(apiOp *APIRequest, name string)

+ func (r *RawResource) MarshalJSON() ([]byte, error)

+ type RequestHandler func(request *APIRequest) (APIObject, error)

+ type RequestListHandler func(request *APIRequest) (APIObjectList, error)

+ type RequestModifier func(request *APIRequest, schema *APISchema) *APISchema

+ type Resource struct

+ Actions map[string]string

+ ID string

+ Links map[string]string

+ Type string

+ type ResponseWriter interface

+ Write func(apiOp *APIRequest, code int, obj APIObject)

+ WriteList func(apiOp *APIRequest, code int, obj APIObjectList)

+ type Store interface

+ ByID func(apiOp *APIRequest, schema *APISchema, id string) (APIObject, error)

+ Create func(apiOp *APIRequest, schema *APISchema, data APIObject) (APIObject, error)

+ Delete func(apiOp *APIRequest, schema *APISchema, id string) (APIObject, error)

+ List func(apiOp *APIRequest, schema *APISchema) (APIObjectList, error)

+ Update func(apiOp *APIRequest, schema *APISchema, data APIObject, id string) (APIObject, error)

+ Watch func(apiOp *APIRequest, schema *APISchema, w WatchRequest) (chan APIEvent, error)

+ type URLBuilder interface

+ Action func(schema *APISchema, id string, action string) string

+ Collection func(schema *APISchema) string

+ CollectionAction func(schema *APISchema, action string) string

+ Current func() string

+ Link func(schema *APISchema, id string, linkName string) string

+ Marker func(marker string) string

+ RelativeToRoot func(path string) string

+ ResourceLink func(schema *APISchema, id string) string

+ type Warning struct

+ Agent string

+ Code int

+ Text string

+ type WatchRequest struct

+ ID string

+ Revision string

+ Selector string