api

Documentation

Index

• func OrbSource(ctx context.Context, logger *logger.Logger, namespace string, orb string) (string, error)
• type ConfigResponse
  • func ConfigQuery(ctx context.Context, logger *logger.Logger, configPath string) (*ConfigResponse, error)
  • func OrbQuery(ctx context.Context, logger *logger.Logger, configPath string) (*ConfigResponse, error)
• type CreateNamespaceResponse
  • func CreateNamespace(ctx context.Context, logger *logger.Logger, name string, ...) (*CreateNamespaceResponse, error)
• type CreateOrbResponse
  • func CreateOrb(ctx context.Context, logger *logger.Logger, namespace string, name string) (*CreateOrbResponse, error)
• type GQLResponseErrors
  • func (response GQLResponseErrors) ToError() error
• type PublishOrbResponse
  • func OrbPublish(ctx context.Context, logger *logger.Logger, configPath string, ...) (*PublishOrbResponse, error)

Functions

func OrbSource

func OrbSource(ctx context.Context, logger *logger.Logger, namespace string, orb string) (string, error)

OrbSource gets the source or an orb

Types

type ConfigResponse

type ConfigResponse struct {
	Valid      bool
	SourceYaml string
	OutputYaml string

	GQLResponseErrors
}

ConfigResponse is a structure that matches the result of the GQL query, so that we can use mapstructure to convert from nested maps to a strongly typed struct.

func ConfigQuery

func ConfigQuery(ctx context.Context, logger *logger.Logger, configPath string) (*ConfigResponse, error)

ConfigQuery calls the GQL API to validate and expand config

func OrbQuery

func OrbQuery(ctx context.Context, logger *logger.Logger, configPath string) (*ConfigResponse, error)

OrbQuery validated and expands an orb.

type CreateNamespaceResponse

type CreateNamespaceResponse struct {
	Namespace struct {
		CreatedAt string
		ID        string
	}

	GQLResponseErrors
}

CreateNamespaceResponse type matches the data shape of the GQL response for creating a namespace

func CreateNamespace

func CreateNamespace(ctx context.Context, logger *logger.Logger, name string, organizationName string, organizationVcs string) (*CreateNamespaceResponse, error)

CreateNamespace creates (reserves) a namespace for an organization

type CreateOrbResponse

type CreateOrbResponse struct {
	Orb struct {
		ID string
	}

	GQLResponseErrors
}

CreateOrbResponse type matches the data shape of the GQL response for creating an orb

func CreateOrb

func CreateOrb(ctx context.Context, logger *logger.Logger, namespace string, name string) (*CreateOrbResponse, error)

CreateOrb creates (reserves) an orb within a namespace

type GQLResponseErrors

type GQLResponseErrors struct {
	Errors []struct {
		Message string
	}
}

GQLResponseErrors is a slice of errors returned by the GraphQL server. Each error message is a key-value pair with the structure "Message: string"

func (GQLResponseErrors) ToError

func (response GQLResponseErrors) ToError() error

ToError returns all GraphQL errors for a single response concatenated, or nil.

type PublishOrbResponse

type PublishOrbResponse struct {
	Orb struct {
		CreatedAt string
		Version   string
	}

	GQLResponseErrors
}

The PublishOrbResponse type matches the data shape of the GQL response for publishing an orb.

func OrbPublish

func OrbPublish(ctx context.Context, logger *logger.Logger,
	configPath string, namespace string, orb string, orbVersion string) (*PublishOrbResponse, error)

OrbPublish publishes a new version of an orb