cloudapi

Documentation

Index

• type API
• type Client
  • func New(endpoint, token string) *Client
  • func (c *Client) Repos(ctx context.Context) ([]Repo, error)
  • func (c *Client) ValidateToken(ctx context.Context) error
• type Repo
• type RepoType

Types

type API

type API interface {
	ValidateToken(ctx context.Context) error
	Repos(ctx context.Context) ([]Repo, error)
}

API defines how to interact with the Atlas Cloud API.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a client for the Atlas Cloud API.

func New

func New(endpoint, token string) *Client

New creates a new Client for the Atlas Cloud API.

func (*Client) Repos

func (c *Client) Repos(ctx context.Context) ([]Repo, error)

Repos fetches data of all repositories from the Atlas Cloud.

func (*Client) ValidateToken

func (c *Client) ValidateToken(ctx context.Context) error

ValidateToken validates the token inside the client with the Atlas Cloud API.

type Repo

type Repo struct {
	URL    string
	Title  string
	Slug   string
	Type   RepoType
	Driver string
}

Repo represents a project in the Atlas Cloud API.

type RepoType

type RepoType string

RepoType represents the type of an Atlas Cloud repository.

const (
	SchemaType    RepoType = "SCHEMA"
	DirectoryType RepoType = "MIGRATION_DIRECTORY"
)