encoding

Documentation

Index

• Constants
• func Kind(spec Spec) (string, error)
• func SafeName(str string) string
• type Api
• type Component
• type Domain
• type Envelope
  • func NewEnvelope(metadata *Metadata, spec Spec) (*Envelope, error)
  • func (e *Envelope) Reference() Reference
• type Group
• type Link
• type Location
• type Metadata
• type Reference
• type Relation
• type Spec
• type System
• type User

Constants

const BackstageV1alpha1 = "backstage.io/v1alpha1"

Functions

func Kind

func Kind(spec Spec) (string, error)

func SafeName

func SafeName(str string) string

Strings of length at least 1, and at most 63 Must consist of sequences of [a-z0-9A-Z] possibly separated by one of [-_.]

Types

type Api

type Api struct {
	Type       string    `yaml:"type"`
	Lifecycle  string    `yaml:"lifecycle"`
	Owner      Reference `yaml:"owner"`
	Definition string    `yaml:"definition"`
	System     Reference `yaml:"system,omitempty"`
}

type Component

type Component struct {
	Type           string      `yaml:"type"`
	Lifecycle      string      `yaml:"lifecycle"`
	Owner          Reference   `yaml:"owner"`
	System         Reference   `yaml:"system,omitempty"`
	SubComponentOf Reference   `yaml:"subcomponentOf,omitempty"`
	ProvidesApis   []Reference `yaml:"providesApis,omitempty"`
	ConsumesApis   []Reference `yaml:"consumesApis,omitempty"`
	DependsOn      []Reference `yaml:"dependsOn,omitempty"`
}

type Domain

type Domain struct {
	Owner Reference `yaml:"owner"`
}

type Envelope

type Envelope struct {
	ApiVersion string     `yaml:"apiVersion,omitempty"`
	Kind       string     `yaml:"kind,omitempty"`
	Metadata   *Metadata  `yaml:"metadata,omitempty"`
	Relations  []Relation `yaml:"relations,omitempty"`
	Spec       Spec       `yaml:"spec,omitempty"`
}

https://backstage.io/docs/features/software-catalog/descriptor-format#common-to-all-kinds-the-envelope

func NewEnvelope

func NewEnvelope(metadata *Metadata, spec Spec) (*Envelope, error)

will automatically fix name and namespace using SafeName

func (*Envelope) Reference

func (e *Envelope) Reference() Reference

https://backstage.io/docs/features/software-catalog/references format: [<kind>:][<namespace>/]<name>

type Group

type Group struct {
	Type     string      `yaml:"type"`
	Profile  interface{} `yaml:"profile,omitempty"`
	Parent   Reference   `yaml:"parent,omitempty"`
	Children []Reference `yaml:"children"`
	Members  []Reference `yaml:"members,omitempty"`
}

type Link

type Link struct {
	URL   string `yaml:"url,omitempty"`
	Title string `yaml:"title,omitempty"`
	Icon  string `yaml:"icon,omitempty"`
	Type  string `yaml:"type,omitempty"`
}

https://backstage.io/docs/features/software-catalog/descriptor-format#links-optional

type Location

type Location struct {
	Type     string   `yaml:"type,omitempty"`
	Target   string   `yaml:"target,omitempty"`
	Targets  []string `yaml:"targets,omitempty"`
	Presence string   `yaml:"presence,omitempty"` // "required" (default) | "optional"
}

type Metadata

type Metadata struct {
	Name        string            `yaml:"name,omitempty"`
	Namespace   string            `yaml:"namespace,omitempty"`
	Title       string            `yaml:"title,omitempty"`
	Description string            `yaml:"description,omitempty"`
	Labels      map[string]string `yaml:"labels,omitempty"`
	Annotations map[string]string `yaml:"annotations,omitempty"`
	Tags        []string          `yaml:"tags,omitempty"`
	Links       []Link            `yaml:"links,omitempty"`
}

https://backstage.io/docs/features/software-catalog/descriptor-format#common-to-all-kinds-the-metadata

type Reference

type Reference string

https://backstage.io/docs/features/software-catalog/references [<kind>:][<namespace>/]<name>

type Relation

type Relation struct {
	Target Reference `yaml:"target,omitempty"`
	Type   string    `yaml:"type,omitempty"`
}

https://backstage.io/docs/features/software-catalog/descriptor-format#common-to-all-kinds-relations

type Spec

type Spec interface{}

type System

type System struct {
	Owner  Reference `yaml:"owner"`
	Domain Reference `yaml:"domain,omitempty"`
}

type User

type User struct {
	MemberOf []Reference `yaml:"memberOf"`
	Profile  interface{} `yaml:"profile,omitempty"`
}