api

Apr 28, 2025

Changes in this version

+ var ErrNotFound = errors.New("not found")

type Client

+ func (c *Client) GetAuthor(ctx context.Context) (*Author, error)

Apr 6, 2025

Changes in this version

type Client

+ func (c *Client) CreateTraining(ctx context.Context, req CreateTrainingRequest) (*Training, error)

+ func (c *Client) DeleteTraining(ctx context.Context, name string) error

+ func (c *Client) GetTraining(ctx context.Context, name string) (*Training, error)

+ func (c *Client) ListAuthoredTrainings(ctx context.Context) ([]Training, error)

+ func (c *Client) ListTrainings(ctx context.Context) ([]Training, error)

+ type CreateTrainingRequest struct

+ Name string

+ Sample bool

+ type Training struct

+ Authors []Author

+ CreatedAt string

+ Name string

+ PageURL string

+ Title string

+ UpdatedAt string

+ func (t *Training) GetKind() content.ContentKind

+ func (t *Training) GetName() string

+ func (t *Training) GetPageURL() string

+ func (t *Training) IsAuthoredBy(userID string) bool

+ func (t *Training) IsOfficial() bool

Mar 25, 2025

Changes in this version

type MachineUser

+ Welcome string

Mar 22, 2025

Changes in this version

+ type AccessMode string

+ const AccessPrivate

+ const AccessPublic

type Client

+ func (c *Client) ExposePort(ctx context.Context, id string, req ExposePortRequest) (*Port, error)

+ func (c *Client) ExposeShell(ctx context.Context, id string, req ExposeShellRequest) (*Shell, error)

+ func (c *Client) ListPorts(ctx context.Context, id string) ([]*Port, error)

+ func (c *Client) ListShells(ctx context.Context, id string) ([]*Shell, error)

+ func (c *Client) UnexposePort(ctx context.Context, id string, portID string) error

+ func (c *Client) UnexposeShell(ctx context.Context, id string, shellID string) error

+ type ExposePortRequest struct

+ Access AccessMode

+ HostRewrite string

+ Machine string

+ Number int

+ PathRewrite string

+ TLS bool

+ type ExposeShellRequest struct

+ Access AccessMode

+ Machine string

+ User string

type PlaygroundTab

+ HostRewrite string

+ PathRewrite string

+ Tls bool

+ type Port struct

+ AccessMode AccessMode

+ HostRewrite string

+ Hostname string

+ ID string

+ Machine string

+ Number int

+ PathRewrite string

+ PlayID string

+ TLS bool

+ URL string

+ type Shell struct

+ AccessMode AccessMode

+ Hostname string

+ ID string

+ Machine string

+ PlayID string

+ URL string

+ User string

Mar 18, 2025

Changes in this version

type CreatePlaygroundRequest

+ AccessControl PlaygroundAccessControl

+ Markdown string

+ Name string

+ type GetPlaygroundOptions struct

+ Format string

type Playground

+ AccessControl PlaygroundAccessControl

+ Markdown string

+ Published bool

+ UserAccess PlaygroundUserAccess

+ type PlaygroundAccessControl struct

+ CanList []string

+ CanRead []string

+ CanStart []string

type PlaygroundManifest

+ Base string

+ Cover string

+ Markdown string

+ Name string

type PlaygroundSpec

+ AccessControl PlaygroundAccessControl

+ func (s *PlaygroundSpec) HasAccessControl() bool

+ type PlaygroundUserAccess struct

+ CanList bool

+ CanRead bool

+ CanStart bool

type UpdatePlaygroundRequest

+ AccessControl PlaygroundAccessControl

+ Cover string

+ Markdown string

Mar 7, 2025

Changes in this version

type Client

+ func (c *Client) CreateRoadmap(ctx context.Context, req CreateRoadmapRequest) (*Roadmap, error)

+ func (c *Client) DeleteRoadmap(ctx context.Context, name string) error

+ func (c *Client) GetRoadmap(ctx context.Context, name string) (*Roadmap, error)

+ func (c *Client) ListAuthoredRoadmaps(ctx context.Context) ([]Roadmap, error)

+ func (c *Client) ListRoadmaps(ctx context.Context) ([]Roadmap, error)

+ type CreateRoadmapRequest struct

+ Name string

+ Sample bool

+ type Roadmap struct

+ Authors []Author

+ CreatedAt string

+ Name string

+ PageURL string

+ Title string

+ UpdatedAt string

+ func (t *Roadmap) GetKind() content.ContentKind

+ func (t *Roadmap) GetName() string

+ func (t *Roadmap) GetPageURL() string

+ func (t *Roadmap) IsAuthoredBy(userID string) bool

+ func (t *Roadmap) IsOfficial() bool

Feb 21, 2025

Changes in this version

type Client

+ func (c *Client) DeletePlayground(ctx context.Context, name string) error

Dec 15, 2024

Changes in this version

+ type ListPlaygroundsOptions struct

+ Filter string

type Machine

+ Resources MachineResources

+ type MachineResources struct

+ CPUCount int

+ RAMSize string

type Playground

+ RegistryAuth string

type PlaygroundAccess

+ Users []string

type PlaygroundMachine

+ Resources MachineResources

type PlaygroundManifest

+ Categories []string

+ Description string

+ Title string

Dec 14, 2024

Changes in this version

type Author

+ Official bool

+ UserID string

type Challenge

+ Authors []Author

+ func (ch *Challenge) IsAuthoredBy(userID string) bool

+ func (ch *Challenge) IsOfficial() bool

type Client

+ func (c *Client) CreatePlayground(ctx context.Context, req CreatePlaygroundRequest) (*Playground, error)

+ func (c *Client) UpdatePlayground(ctx context.Context, name string, req UpdatePlaygroundRequest) (*Playground, error)

type Course

+ Authors []Author

+ func (c *Course) IsAuthoredBy(userID string) bool

+ func (c *Course) IsOfficial() bool

type CreatePlayRequest

+ SafetyDisclaimerConsent bool

+ type CreatePlaygroundRequest struct

+ Access PlaygroundAccess

+ Base string

+ Categories []string

+ Description string

+ InitConditions InitConditions

+ InitTasks map[string]InitTask

+ Machines []PlaygroundMachine

+ RegistryAuth string

+ Tabs []PlaygroundTab

+ Title string

+ type InitCondition struct

+ Key string

+ Value string

+ type InitConditionValue struct

+ Default string

+ Key string

+ Nullable bool

+ Options []string

+ type InitConditions struct

+ Values []InitConditionValue

+ type InitTask struct

+ Conditions []InitCondition

+ Init bool

+ Machine string

+ Name string

+ Needs []string

+ Run string

+ Status int

+ TimeoutSeconds int

+ User string

type Play

+ Tasks map[string]PlayTask

+ func (p *Play) CountCompletedInitTasks() int

+ func (p *Play) CountInitTasks() int

+ func (p *Play) IsCompletable() bool

+ func (p *Play) IsFailed() bool

+ func (p *Play) IsInitialized() bool

+ type PlayConn struct

+ func NewPlayConn(ctx context.Context, play *Play, client *Client, origin string) *PlayConn

+ func (pc *PlayConn) Close()

+ func (pc *PlayConn) Start() error

+ func (pc *PlayConn) WaitDone() error

+ func (pc *PlayConn) WaitPlayReady(timeout time.Duration, s *spinner.Spinner) error

+ type PlayConnMessage struct

+ Kind string

+ Machine string

+ Task PlayTask

type Playground

+ Access PlaygroundAccess

+ Base string

+ Cover string

+ ID string

+ InitConditions InitConditions

+ InitTasks map[string]InitTask

+ Machines []PlaygroundMachine

+ Owner string

+ PageURL string

+ Tabs []PlaygroundTab

+ type PlaygroundAccess struct

+ Mode string

+ type PlaygroundMachine struct

+ CPUCount int

+ CPUCountMax int

+ DrivePerf string

+ Name string

+ NetworkPerf string

+ RAMSize string

+ RAMSizeMax string

+ Users []MachineUser

+ type PlaygroundManifest struct

+ Kind string

+ Playground PlaygroundSpec

+ type PlaygroundSpec struct

+ Access PlaygroundAccess

+ Categories []string

+ Description string

+ InitConditions InitConditions

+ InitTasks map[string]InitTask

+ Machines []PlaygroundMachine

+ Name string

+ RegistryAuth string

+ Tabs []PlaygroundTab

+ Title string

+ type PlaygroundTab struct

+ ID string

+ Kind string

+ Machine string

+ Name string

+ Number int

type SkillPath

+ Authors []Author

+ func (t *SkillPath) IsAuthoredBy(userID string) bool

+ func (t *SkillPath) IsOfficial() bool

+ type StartChallengeOptions struct

+ SafetyDisclaimerConsent bool

type Tutorial

+ Authors []Author

+ func (t *Tutorial) IsAuthoredBy(userID string) bool

+ func (t *Tutorial) IsOfficial() bool

+ type UpdatePlaygroundRequest struct

+ Access PlaygroundAccess

+ Categories []string

+ Description string

+ InitConditions InitConditions

+ InitTasks map[string]InitTask

+ Machines []PlaygroundMachine

+ RegistryAuth string

+ Tabs []PlaygroundTab

+ Title string

Nov 20, 2024

Changes in this version

+ var ErrGatewayTimeout = errors.New("gateway timeout")

Oct 22, 2024

Changes in this version

type ListChallengesOptions

+ Status []string

Sep 27, 2024

Changes in this version

+ var ErrAuthenticationRequired = errors.New("authentication required")

Sep 6, 2024

Changes in this version

type Client

+ func (c *Client) CreateSkillPath(ctx context.Context, req CreateSkillPathRequest) (*SkillPath, error)

+ func (c *Client) DeleteSkillPath(ctx context.Context, name string) error

+ func (c *Client) GetSkillPath(ctx context.Context, name string) (*SkillPath, error)

+ func (c *Client) ListAuthoredSkillPaths(ctx context.Context) ([]SkillPath, error)

+ func (c *Client) ListSkillPaths(ctx context.Context) ([]SkillPath, error)

type CreateChallengeRequest

+ Sample bool

type CreateCourseRequest

+ Sample bool

+ type CreateSkillPathRequest struct

+ Name string

+ Sample bool

type CreateTutorialRequest

+ Sample bool

+ type SkillPath struct

+ CreatedAt string

+ Name string

+ PageURL string

+ Title string

+ UpdatedAt string

+ func (t *SkillPath) GetKind() content.ContentKind

+ func (t *SkillPath) GetName() string

+ func (t *SkillPath) GetPageURL() string

Aug 27, 2024

Changes in this version

type Challenge

+ Categories []string

+ Description string

+ Play *Play

+ Tags []string

+ Tasks map[string]PlayTask

+ Title string

+ func (ch *Challenge) CountCompletedInitTasks() int

+ func (ch *Challenge) CountInitTasks() int

+ func (ch *Challenge) IsCompletable() bool

+ func (ch *Challenge) IsFailed() bool

+ func (ch *Challenge) IsInitialized() bool

type Client

+ func (c *Client) CompleteChallenge(ctx context.Context, name string) (*Challenge, error)

+ func (c *Client) Patch(ctx context.Context, path string, query url.Values, headers http.Header, ...) (*http.Response, error)

+ func (c *Client) PatchInto(ctx context.Context, path string, query url.Values, headers http.Header, ...) error

+ func (c *Client) RequestPlayConn(ctx context.Context, id string) (*PlayConnHandle, error)

+ func (c *Client) StartChallenge(ctx context.Context, name string) (*Challenge, error)

+ func (c *Client) StopChallenge(ctx context.Context, name string) (*Challenge, error)

type Course

+ Title string

+ type ListChallengesOptions struct

+ Category string

type Machine

+ Users []MachineUser

+ func (m *Machine) DefaultUser() *MachineUser

+ func (m *Machine) HasUser(name string) bool

+ type MachineUser struct

+ Default bool

+ Name string

+ type PlayConnHandle struct

+ URL string

+ type PlayTask struct

+ Helper bool

+ Init bool

+ Name string

+ Status PlayTaskStatus

+ Version int

+ type PlayTaskStatus int

+ const PlayTaskStatusBlocked

+ const PlayTaskStatusCompleted

+ const PlayTaskStatusCreated

+ const PlayTaskStatusFailed

+ const PlayTaskStatusNone

+ const PlayTaskStatusRunning

type StartTunnelRequest

+ SSHUser string

type Tutorial

+ Title string

Mar 24, 2024

Changes in this version

+ type Author struct

+ DisplayName string

+ ExternalProfileURL string

+ type Challenge struct

+ AttemptCount int

+ CompletionCount int

+ CreatedAt string

+ Name string

+ PageURL string

+ UpdatedAt string

+ func (ch *Challenge) GetKind() content.ContentKind

+ func (ch *Challenge) GetName() string

+ func (ch *Challenge) GetPageURL() string

type Client

+ func (c *Client) CreateAuthor(ctx context.Context, req CreateAuthorRequest) (*Author, error)

+ func (c *Client) CreateChallenge(ctx context.Context, req CreateChallengeRequest) (*Challenge, error)

+ func (c *Client) CreateCourse(ctx context.Context, req CreateCourseRequest) (*Course, error)

+ func (c *Client) CreateTutorial(ctx context.Context, req CreateTutorialRequest) (*Tutorial, error)

+ func (c *Client) DeleteChallenge(ctx context.Context, name string) error

+ func (c *Client) DeleteContentFile(ctx context.Context, kind content.ContentKind, name string, file string) error

+ func (c *Client) DeleteCourse(ctx context.Context, name string) error

+ func (c *Client) DeleteTutorial(ctx context.Context, name string) error

+ func (c *Client) Download(ctx context.Context, path string, query url.Values, headers http.Header, ...) error

+ func (c *Client) DownloadContentFile(ctx context.Context, kind content.ContentKind, name string, file string, ...) error

+ func (c *Client) DownloadTo(ctx context.Context, path string, query url.Values, headers http.Header, ...) error

+ func (c *Client) GetChallenge(ctx context.Context, name string) (*Challenge, error)

+ func (c *Client) GetCourse(ctx context.Context, name string) (*Course, error)

+ func (c *Client) GetMe(ctx context.Context) (*Me, error)

+ func (c *Client) GetTutorial(ctx context.Context, name string) (*Tutorial, error)

+ func (c *Client) ListAuthoredChallenges(ctx context.Context) ([]Challenge, error)

+ func (c *Client) ListAuthoredCourses(ctx context.Context) ([]Course, error)

+ func (c *Client) ListAuthoredTutorials(ctx context.Context) ([]Tutorial, error)

+ func (c *Client) ListAuthors(ctx context.Context, filter ListAuthorsFilter) ([]Author, error)

+ func (c *Client) ListChallenges(ctx context.Context) ([]Challenge, error)

+ func (c *Client) ListContentFiles(ctx context.Context, kind content.ContentKind, name string) ([]string, error)

+ func (c *Client) ListCourses(ctx context.Context) ([]Course, error)

+ func (c *Client) ListTutorials(ctx context.Context) ([]Tutorial, error)

+ func (c *Client) Put(ctx context.Context, path string, query url.Values, headers http.Header, ...) (*http.Response, error)

+ func (c *Client) PutContentMarkdown(ctx context.Context, kind content.ContentKind, name string, file string, ...) error

+ func (c *Client) PutInto(ctx context.Context, path string, query url.Values, headers http.Header, ...) error

+ func (c *Client) Upload(ctx context.Context, url string, src io.Reader) (*http.Response, error)

+ func (c *Client) UploadContentFile(ctx context.Context, kind content.ContentKind, name string, file string, ...) error

+ func (c *Client) UploadFrom(ctx context.Context, url string, file string) (*http.Response, error)

type ClientOptions

+ APIBaseURL string

+ type Course struct

+ CreatedAt string

+ Name string

+ PageURL string

+ UpdatedAt string

+ func (c *Course) GetKind() content.ContentKind

+ func (c *Course) GetName() string

+ func (c *Course) GetPageURL() string

+ type CourseVariant string

+ const CourseVariantModular

+ const CourseVariantSimple

+ type CreateAuthorRequest struct

+ type CreateChallengeRequest struct

+ Name string

+ type CreateCourseRequest struct

+ Name string

+ Variant CourseVariant

+ type CreateTutorialRequest struct

+ Name string

+ type ListAuthorsFilter struct

+ UserID []string

type Me

+ PremiumAccess *PremiumAccess

+ type PremiumAccess struct

+ Lifetime bool

+ Trial bool

+ Until string

+ type Tutorial struct

+ CreatedAt string

+ Name string

+ PageURL string

+ UpdatedAt string

+ func (t *Tutorial) GetKind() content.ContentKind

+ func (t *Tutorial) GetName() string

+ func (t *Tutorial) GetPageURL() string

Mar 7, 2024

Changes in this version

+ type Client struct

+ func NewClient(opts ClientOptions) *Client

+ func (c *Client) CreatePlay(ctx context.Context, req CreatePlayRequest) (*Play, error)

+ func (c *Client) CreateSession(ctx context.Context) (*Session, error)

+ func (c *Client) Delete(ctx context.Context, path string, query url.Values, headers http.Header) (*http.Response, error)

+ func (c *Client) DeletePlay(ctx context.Context, id string) error

+ func (c *Client) DeleteSession(ctx context.Context, id string) error

+ func (c *Client) Get(ctx context.Context, path string, query url.Values, headers http.Header) (*http.Response, error)

+ func (c *Client) GetAccount(ctx context.Context) (*Me, error)

+ func (c *Client) GetInto(ctx context.Context, path string, query url.Values, headers http.Header, ...) error

+ func (c *Client) GetPlay(ctx context.Context, id string) (*Play, error)

+ func (c *Client) GetPlayground(ctx context.Context, name string) (*Playground, error)

+ func (c *Client) GetSession(ctx context.Context, id string) (*Session, error)

+ func (c *Client) ListPlaygrounds(ctx context.Context) ([]Playground, error)

+ func (c *Client) ListPlays(ctx context.Context) ([]*Play, error)

+ func (c *Client) Post(ctx context.Context, path string, query url.Values, headers http.Header, ...) (*http.Response, error)

+ func (c *Client) PostInto(ctx context.Context, path string, query url.Values, headers http.Header, ...) error

+ func (c *Client) SetCredentials(sessionID, accessToken string)

+ func (c *Client) StartTunnel(ctx context.Context, id string, req StartTunnelRequest) (*StartTunnelResponse, error)

+ type ClientOptions struct

+ AccessToken string

+ BaseURL string

+ SessionID string

+ UserAgent string

+ type CreatePlayRequest struct

+ Playground string

+ type Machine struct

+ CPUCount int

+ DrivePerf string

+ Name string

+ NetworkPerf string

+ RAMSize string

+ type Me struct

+ GithubProfileId string

+ ID string

+ type Play struct

+ Active bool

+ Challenge ...

+ ChallengeName string

+ Course ...

+ CourseName string

+ CreatedAt string

+ Destroyed bool

+ ExpiresIn int

+ Failed bool

+ ID string

+ LastStateAt string

+ Lesson ...

+ LessonPath string

+ Machines []Machine

+ PageURL string

+ Playground Playground

+ Running bool

+ Tutorial ...

+ TutorialName string

+ UpdatedAt string

+ func (p *Play) GetMachine(name string) *Machine

+ type Playground struct

+ Categories []string

+ Description string

+ Name string

+ Title string

+ type PortAccess string

+ const PortAccessPrivate

+ const PortAccessPublic

+ type Session struct

+ AccessToken string

+ AuthURL string

+ Authenticated bool

+ ID string

+ UserID string

+ type StartTunnelRequest struct

+ Access PortAccess

+ GenerateLoginURL bool

+ Machine string

+ Port int

+ SSHPubKey string

+ type StartTunnelResponse struct

+ LoginURL string

+ URL string