Documentation
¶
Overview ¶
Package artifact defines artifact metadata shared by the engine and CLI.
Index ¶
Constants ¶
View Source
const ModuleDimension = "module"
Variables ¶
This section is empty.
Functions ¶
func IsStaticDimension ¶
IsStaticDimension identifies keys available without loading collections.
Types ¶
type Dimension ¶
type Dimension struct {
Kind string
CollectionType string
Identifier string `field:"true" doc:"Stable identifier: collection schema path, type:TypeName for an artifact type, or module."`
Name string `field:"true" doc:"Short name used to select this dimension."`
QualifiedName string `field:"true" doc:"Qualified name used when the short name is ambiguous."`
ItemType string `field:"true" doc:"The collection item or artifact type name, or empty for the module dimension."`
KeyName string `field:"true" doc:"The collection key argument name, or name for a static dimension."`
KeyDescription string `field:"true" doc:"The collection key argument description, or empty for a static dimension."`
}
Dimension describes a schema axis, independent of its runtime keys.
type Dimensions ¶
type Dimensions []*Dimension
Dimensions is the set of dimensions in a selected schema scope.
func (Dimensions) DisplayName ¶
func (dims Dimensions) DisplayName(dim *Dimension) string
DisplayName returns the shortest unambiguous name for a dimension.
Click to show internal directories.
Click to hide internal directories.