api

package

Go to main page

Versions in this module

v0

v0.1.41

May 8, 2026

v0.1.40

May 3, 2026

Changes in this version

+ type HTTPGetAction struct

+ Path string

+ PortName string

+ Scheme string

+ type Path struct

+ Access string

+ Description string

+ Name string

+ Path string

+ Persistence string

+ Sources []ValueSource

+ type Port struct

+ Default int

+ Description string

+ Name string

+ Protocol string

+ Sources []ValueSource

+ type Probe struct

+ HTTPGet *HTTPGetAction

+ Name string

+ Type string

+ type RuntimeSpec struct

+ Paths []Path

+ Ports []Port

+ Probes []Probe

+ type ValueSource struct

+ ConfigKey string

+ ConfigPath string

+ EnvVar string

+ Flag string

+ Type string

v0.1.39

May 1, 2026

v0.1.38

Apr 30, 2026

Changes in this version

type MutationConflict

+ UnitID uuid.UUID

v0.1.37

Apr 29, 2026

Changes in this version

+ const OutputTypeMutationConflictList

+ type ArrayElementAliasMap map[ResolvedPath]map[string]string

+ type ArrayOrderMap map[ResolvedPath][]string

+ type ConflictReason string

+ const ConflictReasonDeleteShadowed

+ const ConflictReasonPredicateFiltered

+ const ConflictReasonSubtracted

+ const ConflictReasonUnresolvedPath

+ type MutationConflict struct

+ Path ResolvedPath

+ Reason ConflictReason

+ Resource ResourceInfo

+ Source MutationInfo

+ Target *MutationInfo

+ type MutationConflictList []MutationConflict

type ResourceMutation

+ ArrayElementAliases ArrayElementAliasMap

+ ArrayOrders ArrayOrderMap

v0.1.36

Apr 27, 2026

v0.1.35

Apr 26, 2026

v0.1.34

Apr 25, 2026

v0.1.33

Apr 25, 2026

v0.1.32

Apr 24, 2026

Changes in this version

+ func ParseStringArrayCSV(value any) ([]string, error)

v0.1.31

Apr 23, 2026

Changes in this version

type FunctionSignature

+ ToolchainType workerapi.ToolchainType

v0.1.30

Apr 22, 2026

Changes in this version

+ func GetIncludeDetails(options *FunctionOptions) bool

+ type FunctionInvocationOptions struct

+ NumFilters int

+ StopOnError bool

+ WhereResource string

type FunctionOptions

+ IncludeDetails bool

+ func NewFunctionOptions() *FunctionOptions

v0.1.29

Apr 20, 2026

v0.1.28

Apr 16, 2026

Changes in this version

+ const DataTypeStringArray

+ const ResourceCategoryDynamicData

v0.1.27

Apr 7, 2026

v0.1.26

Apr 6, 2026

Changes in this version

type FunctionInvocationRequest

+ OtherData map[OtherDataSource][]byte

type FunctionSignature

+ OtherDataExpected []OtherDataSource

+ type OtherDataSource string

v0.1.25

Apr 2, 2026

Changes in this version

+ func HasMutations(mutations ResourceMutationList) bool

type FunctionInvocationSuccessResponse

+ HasNewMutations bool

type Score

+ func ValidateScore(s string) (Score, error)

v0.1.24

Mar 29, 2026

v0.1.23

Mar 28, 2026

v0.1.22

Mar 28, 2026

v0.1.21

Mar 28, 2026

v0.1.20

Mar 28, 2026

v0.1.19

Mar 28, 2026

v0.1.18

Mar 28, 2026

v0.1.17

Mar 28, 2026

Changes in this version

+ func DeepCopyStringMap(m map[string]string) map[string]string

type AttributeDetails

+ func DeepCopyAttributeDetails(d *AttributeDetails) *AttributeDetails

type AttributeInfo

+ func DeepCopyAttributeInfo(ai AttributeInfo) AttributeInfo

type AttributeNeedsProvidesDetails

+ BoundLinkID uuid.UUID

+ BoundProvidedProperties map[string]string

+ func DeepCopyAttributeNeedsProvidesDetails(d AttributeNeedsProvidesDetails) AttributeNeedsProvidesDetails

type FunctionArgument

+ func DeepCopyFunctionArguments(args []FunctionArgument) []FunctionArgument

type FunctionInvocation

+ func DeepCopyFunctionInvocation(fi FunctionInvocation) FunctionInvocation

v0.1.16

Mar 27, 2026

v0.1.15

Mar 27, 2026

Changes in this version

+ const AttributeNameContainerFlag

+ const MaxExpressionLength

+ const MaxOriginalValueLength

+ const MaxResourceCategoryLength

+ const MaxResourceNameLength

+ var ToolchainTypeToDataType = map[workerapi.ToolchainType]DataType

+ type AttributeNeedsProvidesDetails struct

+ IsNeeded bool

+ IsProvided bool

+ NeededPreferred map[string]string

+ NeededRequired map[string]string

+ ProvidedProperties map[string]string

+ type AttributeVisitorDetails struct

type PathVisitorInfo

+ Enricher any

type ResourceInfo

+ ResourceMergeID string

+ ResourceNameStableCore ResourceName

type ResourceMutationIndex

+ ResourceMergeIDMap map[string]int

type ResourceName

+ func EffectiveResourceName(ri *ResourceInfo) ResourceName

v0.1.14

Mar 24, 2026

Changes in this version

+ const DataTypeText

+ const EmbeddedAccessorJSON

+ const EmbeddedAccessorLine

+ const EmbeddedAccessorYAML

type MutationInfo

+ Patch string

type VisitorRelationalExpression

+ func GetWhereResourceExpressions(options *FunctionOptions) []*VisitorRelationalExpression

v0.1.13

Mar 23, 2026

Changes in this version

+ var EmptyDataHash = HashConfigDataSHA256(nil)

+ func IsEmptyDataHash(hash DataHash) bool

+ type AttributeSelector struct

+ Path UnresolvedPath

+ WhereResource string

v0.1.12

Mar 20, 2026

Changes in this version

+ const AttributeNameContainerImage

+ const AttributeNameContainerImageReference

+ const AttributeNameContainerImages

+ const AttributeNameContainerName

+ const AttributeNameContainerRepositoryURI

+ const AttributeNameDefaultName

+ const AttributeNameDetail

+ const AttributeNameDomain

+ const AttributeNameHostname

+ const AttributeNameNone

+ const AttributeNamePrefixRegexpString

+ const AttributeNameResourceName

+ const AttributeNameSubdomain

+ const DataTypeAttributeInfoList

+ const DataTypeAttributeValueList

+ const DataTypeBool

+ const DataTypeCEL

+ const DataTypeEnum

+ const DataTypeEnv

+ const DataTypeHCL

+ const DataTypeINI

+ const DataTypeInt

+ const DataTypeJSON

+ const DataTypeNone

+ const DataTypePatchMap

+ const DataTypeProperties

+ const DataTypeResourceList

+ const DataTypeResourceMutationList

+ const DataTypeString

+ const DataTypeStringBoolMap

+ const DataTypeStringMap

+ const DataTypeStringStringUUIDBoolMap

+ const DataTypeTOML

+ const DataTypeTime

+ const DataTypeUUID

+ const DataTypeUUIDArray

+ const DataTypeUUIDStringMap

+ const DataTypeValueFilter

+ const DataTypeYAML

+ const EmbeddedAccessorRegexp

+ const EvaluatorCEL

+ const EvaluatorTemplate

+ const FunctionNamePrefixRegexpString

+ const FunctionTypeCustom

+ const FunctionTypePathVisitor

+ const MaxAttributeNameLength

+ const MaxConfigDataLength

+ const MaxDataTypeLength

+ const MaxEmbeddedAccessorConfigLength

+ const MaxFilterLength

+ const MaxFunctionDescriptionLength

+ const MaxFunctionErrorMessageLength

+ const MaxFunctionNameLength

+ const MaxFunctionNumberOfErrors

+ const MaxFunctionOutputLength

+ const MaxFunctionParameterNameLength

+ const MaxNumFunctionArguments

+ const MaxPathLength

+ const MaxResourceTypeLength

+ const OutputTypeAttributeValueList

+ const OutputTypeCustomJSON

+ const OutputTypeOpaque

+ const OutputTypePatchMap

+ const OutputTypeResourceInfoList

+ const OutputTypeResourceList

+ const OutputTypeResourceMutationList

+ const OutputTypeValidationResult

+ const OutputTypeValidationResultList

+ const OutputTypeYAML

+ const PathRegexpString

+ const ResourceCategoryAppConfig

+ const ResourceCategoryDyanmicData

+ const ResourceCategoryInvalid

+ const ResourceCategoryResource

+ const ResourceTypeAny

+ const ScoreCritical

+ const ScoreHigh

+ const ScoreLow

+ const ScoreMedium

+ const ScoreNone

+ var AttributeValueListSchema jsonschema.Schema

+ var BooleanLiteralRegexp = regexp.MustCompile(booleanLiteralRegexpString)

+ var ImportSupportedOperators = []string

+ var IntegerLiteralRegexp = regexp.MustCompile(integerLiteralRegexpString)

+ var LogicalOperatorRegexp = regexp.MustCompile(logicalOperatorRegexpString)

+ var NumberToScore = map[int]Score

+ var ResourceInfoListSchema jsonschema.Schema

+ var ResourceListSchema jsonschema.Schema

+ var ResourceMutationListSchema jsonschema.Schema

+ var SafeStringCharsOnlyRegexp = regexp.MustCompile("^" + safeStringCharsRegexpString + "$")

+ var ScoreToNumber = map[Score]int

+ var StringLiteralRegexp = regexp.MustCompile(stringLiteralRegexpString)

+ var SupportedToolchains = map[workerapi.ToolchainType]string

+ var ValidWhereResourcePaths = map[string]bool

+ var ValidationResultFalse = ValidationResult

+ var ValidationResultListSchema jsonschema.Schema

+ var ValidationResultTrue = ValidationResult

+ var YAMLPayloadSchema jsonschema.Schema

+ func CombineOutputs(functionName string, instance string, newOutputType OutputType, ...) (map[OutputType]any, []string)

+ func ConfigDataHasChanged(functionContext *FunctionContext, data []byte) bool

+ func DataTypeIsSerializedAsString(dataType DataType) bool

+ func EvaluateExpression(expr *RelationalExpression, leftValue any, rightValue any, ...) (bool, error)

+ func EvaluatePermissionsExpression(operator string, leftValue PermissionsData, rightValue interface{}, ...) (bool, error)

+ func FindAncestorPath(m MutationMap, path ResolvedPath) (ResolvedPath, MutationInfo, bool)

+ func GetLogicalOperator(decodedQueryString string) (string, string)

+ func GetToolchainPath(toolchain workerapi.ToolchainType) string

+ func HasAncestorPath(m MutationMap, path ResolvedPath) bool

+ func InitTypeSchemas()

+ func IsSupportedToolchain(toolchain workerapi.ToolchainType) bool

+ func IsUUID(s string) bool

+ func NoMutations(mutations ResourceMutationList) bool

+ func OffsetMutations(mutations ResourceMutationList, offset int64)

+ func ParseInClause(decodedQueryString string) (string, string, error)

+ func ParseInClauseValues(literal string) []string

+ func ParseWhereFilterForImport(queryString string) ([]ImportFilter, ImportOptions, error)

+ func SkipWhitespace(decodedQueryString string) string

+ func SkipWhitespaceWithLimit(decodedQueryString string, limit int) string

+ func SupportedToolchainsToString() string

+ func UnmarshalOutput(outputBytes []byte, outputType OutputType) (any, error)

+ func ValidateImportOperator(operator string) error

+ func ValidatePath(path string) error

+ type AttributeDescriptor struct

+ AttributeGroup []AttributeName

+ AttributeName AttributeName

+ type AttributeDetails struct

+ Description string

+ GetterInvocation *FunctionInvocation

+ SetterInvocations []FunctionInvocation

+ type AttributeIdentifier struct

+ InLiveState bool

+ Path ResolvedPath

+ type AttributeInfo struct

+ type AttributeMetadata struct

+ AttributeName AttributeName

+ DataType DataType

+ Details *AttributeDetails

+ type AttributeName string

+ func AttributeNameForResourceType(resourceType ResourceType) AttributeName

+ type AttributeNameToAttributeDescriptor map[AttributeName]*AttributeDescriptor

+ type AttributeNameToResourceTypeToPathToVisitorInfoType map[AttributeName]ResourceTypeToPathToVisitorInfoType

+ type AttributeValue struct

+ Comment string

+ FunctionName string

+ Index int

+ Issues []Issue

+ Score Score

+ Value any

+ type AttributeValueList []AttributeValue

+ type Binding struct

+ AttributeName AttributeName

+ AutoUpdate bool

+ DataType DataType

+ Expression string

+ InLiveState bool

+ NeededPath ResolvedPath

+ NeededResource ResourceInfo

+ OriginalValue any

+ ProvidedPath ResolvedPath

+ ProvidedResource ResourceInfo

+ type BindingList []Binding

+ type CustomStringComparator interface

+ Evaluate func(expr *RelationalExpression, value string) (bool, error)

+ MatchesPath func(path string) bool

+ type DataHash string

+ func HashConfigDataSHA256(data []byte) DataHash

+ type DataType string

+ func ParseLiteral(decodedQueryString string) (string, string, DataType, error)

+ type EmbeddedAccessorType string

+ type FunctionArgument struct

+ Evaluator string

+ ParameterName string

+ Value any

+ type FunctionContext struct

+ ApprovedBy []string

+ BridgeWorkerID uuid.UUID

+ IsLiveState bool

+ NotLive bool

+ OrganizationID uuid.UUID

+ PreviousContentHash RevisionHash

+ PreviousDataHash DataHash

+ QueuedOperationID uuid.UUID

+ RevisionID uuid.UUID

+ RevisionNum int64

+ SpaceAnnotations map[string]string

+ SpaceID uuid.UUID

+ SpaceLabels map[string]string

+ SpaceSlug string

+ TargetID uuid.UUID

+ ToolchainType workerapi.ToolchainType

+ UnitAnnotations map[string]string

+ UnitID uuid.UUID

+ UnitLabels map[string]string

+ UnitSlug string

+ func (fc *FunctionContext) InstanceString() string

+ type FunctionIDs struct

+ OrganizationID uuid.UUID

+ RevisionID uuid.UUID

+ SpaceID uuid.UUID

+ SpaceSlug string

+ UnitID uuid.UUID

+ UnitSlug string

+ type FunctionInvocation struct

+ Arguments []FunctionArgument

+ FunctionName string

+ type FunctionInvocationList []FunctionInvocation

+ type FunctionInvocationRequest struct

+ ConfigData []byte

+ FunctionInvocations FunctionInvocationList

+ NumFilters int

+ StopOnError bool

+ WhereResource string

+ type FunctionInvocationResponse struct

+ ErrorMessages []string

+ Success bool

+ type FunctionInvocationSuccessResponse struct

+ ConfigData []byte

+ Mutations ResourceMutationList

+ Mutators []int

+ Outputs map[OutputType][]byte

+ type FunctionOptions struct

+ WhereResourceExpressions []*VisitorRelationalExpression

+ func ParseAndValidateWhereResource(whereResource string) (*FunctionOptions, error)

+ type FunctionOutput struct

+ Description string

+ OutputType OutputType

+ ResultName string

+ Schema *jsonschema.Schema

+ type FunctionParameter struct

+ DataType DataType

+ Description string

+ Example string

+ ParameterName string

+ Required bool

+ type FunctionSignature struct

+ AffectedResourceTypes []ResourceType

+ AttributeName AttributeName

+ Description string

+ FunctionName string

+ FunctionType FunctionType

+ Hermetic bool

+ Idempotent bool

+ Mutating bool

+ OutputInfo *FunctionOutput

+ Parameters []FunctionParameter

+ RequiredParameters int

+ Validating bool

+ VarArgs bool

+ type FunctionType string

+ type ImportFilter struct

+ Operator string

+ Type string

+ Values []string

+ type ImportOptions map[string]interface

+ type Issue struct

+ Identifier string

+ Message string

+ type MutationInfo struct

+ Index int64

+ MutationType MutationType

+ Predicate bool

+ Value string

+ type MutationMap map[ResolvedPath]MutationInfo

+ type MutationMapEntry struct

+ MutationInfo *MutationInfo

+ Path ResolvedPath

+ func SortedMutationMapEntries(m MutationMap) []MutationMapEntry

+ type MutationType string

+ const MutationTypeAdd

+ const MutationTypeDelete

+ const MutationTypeNone

+ const MutationTypeReplace

+ const MutationTypeUpdate

+ type OutputType string

+ type PatchMap map[ResourceTypeAndName]ResourcePatch

+ type PathPrefixIndex struct

+ SortedPaths []ResolvedPath

+ func NewPathPrefixIndex(m MutationMap) *PathPrefixIndex

+ func (idx *PathPrefixIndex) ChildPaths(prefix ResolvedPath) []ResolvedPath

+ func (idx *PathPrefixIndex) HasChildPath(prefix ResolvedPath) bool

+ type PathToVisitorInfoType map[UnresolvedPath]*PathVisitorInfo

+ type PathVisitorInfo struct

+ AttributeName AttributeName

+ DataType DataType

+ Details *AttributeDetails

+ EmbeddedAccessorConfig string

+ EmbeddedAccessorType EmbeddedAccessorType

+ IsNeeded bool

+ IsProvided bool

+ Path UnresolvedPath

+ ResolvedPath ResolvedPath

+ TypeExceptions map[ResourceType]struct{}

+ type PermissionsData map[string]map[string]map[uuid.UUID]bool

+ type RelationalExpression struct

+ DataType DataType

+ IsLengthExpression bool

+ Literal string

+ Operator string

+ Path string

+ type ResolvedPath string

+ type Resource struct

+ ResourceBody string

+ type ResourceCategory string

+ type ResourceCategoryType struct

+ ResourceCategory ResourceCategory

+ ResourceType ResourceType

+ type ResourceInfo struct

+ ResourceCategory ResourceCategory

+ ResourceID string

+ ResourceName ResourceName

+ ResourceNameWithoutScope ResourceName

+ ResourceType ResourceType

+ type ResourceInfoList []ResourceInfo

+ type ResourceList []Resource

+ type ResourceMutation struct

+ Aliases map[ResourceName]struct{}

+ AliasesWithoutScopes map[ResourceName]struct{}

+ PathMutationMap MutationMap

+ Resource ResourceInfo

+ ResourceMutationInfo MutationInfo

+ type ResourceMutationIndex struct

+ AliasNameMap map[ResourceTypeAndName]int

+ NameMap map[ResourceTypeAndName]int

+ ResourceIDMap map[string]int

+ func NewResourceMutationIndex(mutations ResourceMutationList) *ResourceMutationIndex

+ func (idx *ResourceMutationIndex) Find(resource ResourceInfo, callerAliases map[ResourceName]struct{}) (int, bool)

+ type ResourceMutationList []ResourceMutation

+ func AttributeValueListToResourceMutationList(avl AttributeValueList) ResourceMutationList

+ type ResourceName string

+ type ResourcePatch struct

+ Patches yamlpatch.Patch

+ type ResourceType string

+ type ResourceTypeAndName string

+ func ResourceTypeAndFullNameFromResourceInfo(resourceInfo ResourceInfo) ResourceTypeAndName

+ func ResourceTypeAndNameFromResourceInfo(resourceInfo ResourceInfo) ResourceTypeAndName

+ type ResourceTypeToPathToVisitorInfoType map[ResourceType]PathToVisitorInfoType

+ type RevisionHash int32

+ func HashConfigData(data []byte) RevisionHash

+ type Scalar interface

+ type Score string

+ func ScoreMax(a, b Score) Score

+ type UnresolvedPath string

+ type ValidationResult struct

+ Details []string

+ FailedAttributes AttributeValueList

+ FunctionName string

+ Index int

+ Issues []Issue

+ MaxScore Score

+ Passed bool

+ type ValidationResultList []ValidationResult

+ type ValueConstraints struct

+ EnumValues []string

+ Max *int

+ Min *int

+ Regexp string

+ Schema *jsonschema.Schema

+ type ValueFilter struct

+ AllowBool *bool

+ AllowRegexp string

+ AllowStrings map[string]bool

+ DenyRegexp string

+ DenyStrings map[string]bool

+ Max *int

+ Min *int

+ type VisitorRelationalExpression struct

+ IsSplitPath bool

+ SubPath string

+ VisitorPath string

+ func ParseAndValidateBinaryExpression(decodedQueryString string) (string, *VisitorRelationalExpression, error)

+ func ParseAndValidateWhereFilter(queryString string) ([]*VisitorRelationalExpression, error)

+ func ParseAndValidateWhereFilterForImport(queryString string) ([]*VisitorRelationalExpression, error)

+ type YAMLPayload struct

+ Payload string

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