patch

package

v1.0.0-beta.232 Latest Latest Go to latest Published: Aug 4, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/openmeterio/openmeter

Links

README ¶

Subscription patches

Patches are typed, ordered transformations of a SubscriptionSpec. They let subscription workflows express a change to desired state before the core service materializes that state.

Patches do not persist subscription rows, schedule entitlements, or create billing artifacts.

Patch contract

Every patch provides:

an operation such as add, remove, stretch, or unschedule
a SpecPath identifying the affected phase, item key, or item version
validation of its own input
an ApplyTo transformation over the spec

Paths express logical subscription identity:

/phases/{phaseKey}
/phases/{phaseKey}/items/{itemKey}
/phases/{phaseKey}/items/{itemKey}/idx/{version}

Use an item-version path only when the operation addresses that exact version. An operation that selects or mutates the relevant version itself belongs at the item path.

Effective time and ordering

ApplyContext.CurrentTime is the command's resolved effective time, not necessarily wall-clock time. Patch rules use it to protect past phases and items and to decide which item version is active.

Patches are applied in order. A later patch sees the spec produced by earlier ones, so valid workflows may deliberately remove an item before adding its replacement. The complete spec is validated after application.

Adding an item to the current phase closes the active version of the same item key and appends a new version. Its relative start is derived from the effective time when the patch does not provide one. Future-phase additions must not silently replace an existing item.

Phase stretch and removal can shift later phase offsets. They must preserve phase ordering and cannot erase a phase by collapsing its duration.

Error meaning

validation errors mean the patch or resulting spec is structurally invalid
forbidden errors mean the requested edit would change protected historical state
conflict errors mean the patch is individually meaningful but incompatible with the surrounding spec or another requested change

The workflow layer maps these errors for callers and passes the resulting complete spec to the subscription service.

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type PatchAddItem ¶

type PatchAddItem struct {
	PhaseKey    string
	ItemKey     string
	CreateInput subscription.SubscriptionItemSpec
}

func (PatchAddItem) ApplyTo ¶

func (a PatchAddItem) ApplyTo(spec *subscription.SubscriptionSpec, actx subscription.ApplyContext) error

func (PatchAddItem) FieldDescriptor ¶

func (a PatchAddItem) FieldDescriptor() *models.FieldDescriptor

func (PatchAddItem) Op ¶

func (a PatchAddItem) Op() subscription.PatchOperation

func (PatchAddItem) Path ¶

func (a PatchAddItem) Path() subscription.SpecPath

func (PatchAddItem) Validate ¶

func (a PatchAddItem) Validate() error

func (PatchAddItem) Value ¶

func (a PatchAddItem) Value() subscription.SubscriptionItemSpec

func (PatchAddItem) ValueAsAny ¶

func (a PatchAddItem) ValueAsAny() any

type PatchAddPhase ¶

type PatchAddPhase struct {
	PhaseKey    string
	CreateInput subscription.CreateSubscriptionPhaseInput
}

func (PatchAddPhase) ApplyTo ¶

func (a PatchAddPhase) ApplyTo(spec *subscription.SubscriptionSpec, actx subscription.ApplyContext) error

func (PatchAddPhase) Op ¶

func (a PatchAddPhase) Op() subscription.PatchOperation

func (PatchAddPhase) Path ¶

func (a PatchAddPhase) Path() subscription.SpecPath

func (PatchAddPhase) Validate ¶

func (a PatchAddPhase) Validate() error

func (PatchAddPhase) Value ¶

func (a PatchAddPhase) Value() subscription.CreateSubscriptionPhaseInput

func (PatchAddPhase) ValueAsAny ¶

func (a PatchAddPhase) ValueAsAny() any

type PatchRemoveItem ¶

type PatchRemoveItem struct {
	PhaseKey string
	ItemKey  string
}

func (PatchRemoveItem) ApplyTo ¶

func (r PatchRemoveItem) ApplyTo(spec *subscription.SubscriptionSpec, actx subscription.ApplyContext) error

RemoveItem removes the last version for the provided key

func (PatchRemoveItem) Op ¶

func (r PatchRemoveItem) Op() subscription.PatchOperation

func (PatchRemoveItem) Path ¶

func (r PatchRemoveItem) Path() subscription.SpecPath

func (PatchRemoveItem) Validate ¶

func (r PatchRemoveItem) Validate() error

type PatchRemovePhase ¶

type PatchRemovePhase struct {
	PhaseKey    string
	RemoveInput subscription.RemoveSubscriptionPhaseInput
}

func (PatchRemovePhase) ApplyTo ¶

func (r PatchRemovePhase) ApplyTo(spec *subscription.SubscriptionSpec, actx subscription.ApplyContext) error

func (PatchRemovePhase) Op ¶

func (r PatchRemovePhase) Op() subscription.PatchOperation

func (PatchRemovePhase) Path ¶

func (r PatchRemovePhase) Path() subscription.SpecPath

func (PatchRemovePhase) Validate ¶

func (r PatchRemovePhase) Validate() error

func (PatchRemovePhase) Value ¶

func (r PatchRemovePhase) Value() subscription.RemoveSubscriptionPhaseInput

func (PatchRemovePhase) ValueAsAny ¶

func (r PatchRemovePhase) ValueAsAny() any

type PatchStretchPhase ¶

type PatchStretchPhase struct {
	PhaseKey string
	// Signed duration
	Duration datetime.ISODuration
}

func (PatchStretchPhase) ApplyTo ¶

func (p PatchStretchPhase) ApplyTo(spec *subscription.SubscriptionSpec, actx subscription.ApplyContext) error

func (PatchStretchPhase) Op ¶

func (p PatchStretchPhase) Op() subscription.PatchOperation

func (PatchStretchPhase) Path ¶

func (p PatchStretchPhase) Path() subscription.SpecPath

func (PatchStretchPhase) Validate ¶

func (p PatchStretchPhase) Validate() error

func (PatchStretchPhase) Value ¶

func (p PatchStretchPhase) Value() datetime.ISODuration

func (PatchStretchPhase) ValueAsAny ¶

func (p PatchStretchPhase) ValueAsAny() any

type PatchUnscheduleEdit ¶

type PatchUnscheduleEdit struct{}

func (PatchUnscheduleEdit) ApplyTo ¶

func (p PatchUnscheduleEdit) ApplyTo(spec *subscription.SubscriptionSpec, actx subscription.ApplyContext) error

"Unscheduling an edit" is a concept that might intuitively makes sense for clients: 1. Making some edit to a subscription 2. You want to do another edit 3. Your edit discards the previous edit

However, this is not really a behavior that makes sense from a server perspective. The compromise we make is that, for most cases, when a client wants to unschedule an edit, all they really want to do is get rid of any future changes to the subscription.

As editing future phases doesn't create multiple versions of the items (see AddItem and RemoveItem), we only tackle editing the current phase.

UnscheduleEdit simply removes all scheduled versions of the items in the current phase.

func (PatchUnscheduleEdit) Op ¶

func (p PatchUnscheduleEdit) Op() subscription.PatchOperation

func (PatchUnscheduleEdit) Path ¶

func (p PatchUnscheduleEdit) Path() subscription.SpecPath

func (PatchUnscheduleEdit) Validate ¶

func (p PatchUnscheduleEdit) Validate() error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL