metadata

Documentation

Index

• type AppMetadata
  • func FromBundle(bndl *bundle.Bundle) AppMetadata
  • func Load(data []byte) (AppMetadata, error)
• type Maintainer
  • func (m Maintainer) String() string
• type Maintainers
  • func (ms Maintainers) String() string

Types

type AppMetadata

type AppMetadata struct {
	Version     string
	Name        string
	Description string      `json:",omitempty"`
	Maintainers Maintainers `json:",omitempty"`
}

AppMetadata is the format of the data found inside the metadata.yml file

func FromBundle

func FromBundle(bndl *bundle.Bundle) AppMetadata

FromBundle extracts the docker-app metadata from the bundle

func Load

func Load(data []byte) (AppMetadata, error)

Load validates the given data and loads it into a metadata struct

type Maintainer

type Maintainer struct {
	Name  string
	Email string `json:",omitempty"`
}

Maintainer represents one of the apps's maintainers

func (Maintainer) String

func (m Maintainer) String() string

String gives a string representation of a maintainer

type Maintainers

type Maintainers []Maintainer

Maintainers is a list of maintainers

func (Maintainers) String

func (ms Maintainers) String() string

String gives a string representation of a list of maintainers