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

overlay

package

Go to main page

Versions in this module

v0

v0.31.2

Jan 6, 2026

v0.31.1

Dec 30, 2025

v0.31.0

Dec 23, 2025

Changes in this version

+ var ErrEmptyActions = errors.New("actions array must contain at least one action")

+ var ErrInvalidJSONPath = errors.New("invalid JSONPath expression")

+ var ErrInvalidOverlay = errors.New("invalid overlay document")

+ var ErrMissingActions = errors.New("missing required 'actions' field")

+ var ErrMissingInfo = errors.New("missing required 'info' field")

+ var ErrMissingOverlayField = errors.New("missing required 'overlay' field")

+ var ErrNoTargetDocument = errors.New("no target document provided")

+ var ErrPrimitiveTarget = errors.New("JSONPath target resolved to primitive/null; must be object or array")

+ type OverlayError struct

+ Action *highoverlay.Action

+ Cause error

+ func (e *OverlayError) Error() string

+ func (e *OverlayError) Unwrap() error

+ type Result struct

+ Bytes []byte

+ Warnings []*Warning

+ func Apply(targetBytes []byte, overlay *highoverlay.Overlay) (*Result, error)

+ type Warning struct

+ Action *highoverlay.Action

+ Message string

+ Target string

+ func (w *Warning) String() string