Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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

entrest

package module

Go to main page

Versions in this module

v1

v1.0.3

Apr 2, 2026

v1.0.2

Aug 21, 2025

v1.0.1

Aug 11, 2025

Changes in this version

+ var SchemaAny = &ogen.Schema

v1.0.0

Jun 23, 2025

Changes in this version

+ const OpenAPIVersion

+ var AllOperations = []Operation

+ var AllSupportedHTTPHandlers = []HTTPHandler

+ var CamelCase = memoize(gen.Funcs["camel"].(func(string) string))

+ var DefaultErrorResponses = ErrorResponses

+ var KebabCase = memoize(strcase.KebabCase)

+ var PascalCase = memoize(gen.Funcs["pascal"].(func(string) string))

+ var Pluralize = memoize(inflect.Pluralize)

+ var RateLimitHeaders = ResponseHeaders

+ var RequestIDHeader = RequestHeaders

+ var SchemaObjectAny = &ogen.Schema

+ var Singularize = memoize(gen.Funcs["singular"].(func(string) string))

+ var SnakeCase = memoize(gen.Funcs["snake"].(func(string) string))

+ func ErrorResponseObject(code int) *ogen.Schema

+ func FuncMaps() template.FuncMap

+ func GetOperationIDName(op Operation, t *gen.Type, e *gen.Edge) string

+ func GetPathName(op Operation, t *gen.Type, e *gen.Edge, useUniqueID bool) string

+ func GetSchemaField(f *gen.Field) (*ogen.Schema, error)

+ func GetSchemaType(t *gen.Type, op Operation, edge *gen.Edge) map[string]*ogen.Schema

+ func GetSortableFields(t *gen.Type, edge *gen.Edge) (sortable []string)

+ func GetSpecEdge(t *gen.Type, e *gen.Edge, op Operation) (*ogen.Spec, error)

+ func GetSpecType(t *gen.Type, op Operation) (*ogen.Spec, error)

+ func MergeSpec(orig *ogen.Spec, toMerge ...*ogen.Spec) error

+ func MergeSpecOverlap(orig *ogen.Spec, toMerge ...*ogen.Spec) error

+ func PatchOperations(pathItem *ogen.PathItem, ...) *ogen.PathItem

+ func PatchPathItem(pathItem *ogen.PathItem, cb func(resp *ogen.Response) *ogen.Response) *ogen.PathItem

+ func ToEnum[T any](values []T) ([]json.RawMessage, error)

+ func ValidateAnnotations(nodes ...*gen.Type) error

+ type Annotation struct

+ AdditionalTags []string

+ AllowClientIDs *bool

+ DefaultOrder *SortOrder

+ DefaultSort *string

+ Deprecated bool

+ Description string

+ DisableHandler bool

+ EagerLoad *bool

+ EagerLoadLimit *int

+ EdgeEndpoint *bool

+ EdgeUpdateBulk bool

+ Example any

+ Filter Predicate

+ FilterGroup string

+ ItemsPerPage int

+ MaxItemsPerPage int

+ MinItemsPerPage int

+ OperationDescription map[Operation]string

+ OperationID map[Operation]string

+ OperationSummary map[Operation]string

+ Operations []Operation

+ Pagination *bool

+ ReadOnly bool

+ Schema *ogen.Schema

+ Skip bool

+ Sortable bool

+ Tags []string

+ func GetAnnotation(v any) *Annotation

+ func WithAdditionalTags(v ...string) Annotation

+ func WithAllowClientIDs(v bool) Annotation

+ func WithDefaultOrder(v SortOrder) Annotation

+ func WithDefaultSort(field string) Annotation

+ func WithDeprecated(v bool) Annotation

+ func WithDescription(v string) Annotation

+ func WithEagerLoad(v bool) Annotation

+ func WithEagerLoadLimit(v int) Annotation

+ func WithEdgeEndpoint(v bool) Annotation

+ func WithEdgeUpdateBulk(v bool) Annotation

+ func WithExample(v any) Annotation

+ func WithExcludeOperations(v ...Operation) Annotation

+ func WithFilter(v Predicate) Annotation

+ func WithFilterGroup(name string) Annotation

+ func WithHandler(v bool) Annotation

+ func WithIncludeOperations(v ...Operation) Annotation

+ func WithItemsPerPage(v int) Annotation

+ func WithMaxItemsPerPage(v int) Annotation

+ func WithMinItemsPerPage(v int) Annotation

+ func WithOperationDescription(op Operation, v string) Annotation

+ func WithOperationID(op Operation, v string) Annotation

+ func WithOperationSummary(op Operation, v string) Annotation

+ func WithPagination(v bool) Annotation

+ func WithReadOnly(v bool) Annotation

+ func WithSchema(v *ogen.Schema) Annotation

+ func WithSkip(v bool) Annotation

+ func WithSortable(v bool) Annotation

+ func WithTags(v ...string) Annotation

+ func (Annotation) Name() string

+ func (a *Annotation) Decode(o any) error

+ func (a *Annotation) GetAllowClientIDs(config *Config) bool

+ func (a *Annotation) GetDefaultOrder() SortOrder

+ func (a *Annotation) GetDefaultSort(hasID bool) string

+ func (a *Annotation) GetEagerLoad(config *Config) bool

+ func (a *Annotation) GetEagerLoadLimit(config *Config) int

+ func (a *Annotation) GetEdgeEndpoint(config *Config) bool

+ func (a *Annotation) GetItemsPerPage(config *Config) int

+ func (a *Annotation) GetMaxItemsPerPage(config *Config) int

+ func (a *Annotation) GetMinItemsPerPage(config *Config) int

+ func (a *Annotation) GetOperationDescription(op Operation) string

+ func (a *Annotation) GetOperationID(op Operation) string

+ func (a *Annotation) GetOperationSummary(op Operation) string

+ func (a *Annotation) GetOperations(config *Config) []Operation

+ func (a *Annotation) GetPagination(config *Config, edge *gen.Edge) bool

+ func (a *Annotation) GetSkip(config *Config) bool

+ func (a *Annotation) HasOperation(config *Config, op Operation) bool

+ func (a Annotation) Merge(o schema.Annotation) schema.Annotation

+ type Config struct

+ AddEdgesToTags bool

+ AllowClientIDs bool

+ DefaultEagerLoad bool

+ DefaultFilterID bool

+ DefaultOperations []Operation

+ DisableEagerLoadNonPagedOpt bool

+ DisableEagerLoadedEndpoints bool

+ DisablePagination bool

+ DisablePatchJSONTag bool

+ DisableSpecHandler bool

+ EagerLoadLimit int

+ GlobalErrorResponses ErrorResponses

+ GlobalRequestHeaders RequestHeaders

+ GlobalResponseHeaders ResponseHeaders

+ Handler HTTPHandler

+ ItemsPerPage int

+ ListNotFound bool

+ MaxItemsPerPage int

+ MinItemsPerPage int

+ PostGenerateHook func(g *gen.Graph, spec *ogen.Spec) error

+ PreGenerateHook func(g *gen.Graph, spec *ogen.Spec) error

+ PreWriteHook func(spec *ogen.Spec) error

+ Spec *ogen.Spec

+ SpecFromPath string

+ StrictMutate bool

+ Templates []*gen.Template

+ WithTesting bool

+ Writer io.Writer

+ func GetConfig(gc *gen.Config) *Config

+ func (c *Config) Decode(o any) error

+ func (c *Config) Validate() error

+ func (c Config) Name() string

+ type ErrorResponses map[int]*ogen.Schema

+ func (r ErrorResponses) Append(toMerge ...ErrorResponses) ErrorResponses

+ type Extension struct

+ func NewExtension(config *Config) (*Extension, error)

+ func (e *Extension) Annotations() []entc.Annotation

+ func (e *Extension) Generate(g *gen.Graph) (*ogen.Spec, error)

+ func (e *Extension) Hooks() []gen.Hook

+ func (e *Extension) Templates() []*gen.Template

+ type FilterGroup struct

+ FieldPairs []*FilterGroupFieldPair

+ FieldType *field.TypeInfo

+ Name string

+ Operations []gen.Op

+ Schema *ogen.Schema

+ Type *gen.Type

+ func GetFilterGroups(t *gen.Type, edge *gen.Edge) []*FilterGroup

+ func (g *FilterGroup) ComponentName(op gen.Op) string

+ func (g *FilterGroup) Description(op gen.Op) string

+ func (g *FilterGroup) Parameter(op gen.Op) *ogen.Parameter

+ func (g *FilterGroup) ParameterName(op gen.Op) string

+ func (g *FilterGroup) PredicateBuilder(structName string, op gen.Op) string

+ func (g *FilterGroup) StructTag(op gen.Op) string

+ func (g *FilterGroup) TypeString(op gen.Op) string

+ type FilterGroupFieldPair struct

+ Edge *gen.Edge

+ Field *gen.Field

+ Type *gen.Type

+ type FilterableFieldOp struct

+ Edge *gen.Edge

+ Field *gen.Field

+ Operation gen.Op

+ Type *gen.Type

+ func GetFilterableFields(t *gen.Type, edge *gen.Edge) (filters []*FilterableFieldOp)

+ func (f *FilterableFieldOp) ComponentName() string

+ func (f *FilterableFieldOp) Description() string

+ func (f *FilterableFieldOp) Parameter() *ogen.Parameter

+ func (f *FilterableFieldOp) ParameterName() string

+ func (f *FilterableFieldOp) PredicateBuilder(structName string) string

+ func (f *FilterableFieldOp) StructTag() string

+ func (f *FilterableFieldOp) TypeString() string

+ type HTTPHandler string

+ const HandlerChi

+ const HandlerNone

+ const HandlerStdlib

+ type Operation string

+ const OperationCreate

+ const OperationDelete

+ const OperationList

+ const OperationRead

+ const OperationUpdate

+ type Predicate int

+ const FilterContains

+ const FilterContainsFold

+ const FilterEQ

+ const FilterEdge

+ const FilterEqualFold

+ const FilterGT

+ const FilterGTE

+ const FilterGroupArray

+ const FilterGroupContains

+ const FilterGroupEqual

+ const FilterGroupEqualExact

+ const FilterGroupLength

+ const FilterGroupNil

+ const FilterHasPrefix

+ const FilterHasSuffix

+ const FilterIn

+ const FilterIsNil

+ const FilterLT

+ const FilterLTE

+ const FilterNEQ

+ const FilterNotIn

+ func (p Predicate) Add(v Predicate) Predicate

+ func (p Predicate) Explode() (ops []gen.Op)

+ func (p Predicate) Has(v Predicate) bool

+ func (p Predicate) Remove(v Predicate) Predicate

+ func (p Predicate) String() string

+ type RequestHeaders map[string]*ogen.Parameter

+ func (r RequestHeaders) Append(toMerge ...RequestHeaders) RequestHeaders

+ type ResponseHeaders map[string]*ogen.Header

+ func (r ResponseHeaders) Append(toMerge ...ResponseHeaders) ResponseHeaders

+ type SortOrder string

+ const OrderAsc

+ const OrderDesc