api

Documentation

Overview

Package api contains definitions for Inertia API requests and responses

Index

• Constants
• type DeploymentStatus
• type EnvRequest
• type GitOptions
• type TotpResponse
• type UpRequest
• type UserRequest

Constants

const (
	// MsgDaemonOK is the OK response upon successfully reaching daemon
	MsgDaemonOK = "I'm a little Webhook, short and stout!"

	// Container is a constant used in HTTP GET query strings
	Container = "container"

	// Stream is a constant used in HTTP GET query strings
	Stream = "stream"

	// Entries is a constant used in HTTP GET query strings
	Entries = "entries"
)

Types

type DeploymentStatus

type DeploymentStatus struct {
	InertiaVersion       string   `json:"version"`
	Branch               string   `json:"branch"`
	CommitHash           string   `json:"commit_hash"`
	CommitMessage        string   `json:"commit_message"`
	BuildType            string   `json:"build_type"`
	Containers           []string `json:"containers"`
	BuildContainerActive bool     `json:"build_active"`
}

DeploymentStatus lists details about the deployed project

type EnvRequest

type EnvRequest struct {
	Name    string `json:"name,omitempty"`
	Value   string `json:"value,omitempty"`
	Encrypt bool   `json:"encrypt,omitempty"`

	Remove bool `json:"remove,omitempty"`
}

EnvRequest represents a request to manage environment variables

type GitOptions

type GitOptions struct {
	RemoteURL string `json:"remote"`
	Branch    string `json:"branch"`
}

GitOptions represents GitHub-related deployment options

type TotpResponse

type TotpResponse struct {
	TotpSecret  string `json:"key"`
	BackupCodes []string
}

TotpResponse is used for sending users their Totp secret and backup codes

type UpRequest

type UpRequest struct {
	Stream          bool       `json:"stream"`
	Project         string     `json:"project"`
	BuildType       string     `json:"build_type"`
	BuildFilePath   string     `json:"build_file_path"`
	GitOptions      GitOptions `json:"git_options"`
	WebHookSecret   string     `json:"webhook_secret"`
	DontKillOnDeath bool       `json:"dont_kill_on_death"`
}

UpRequest is the configurable body of a UP request to the daemon.

type UserRequest

type UserRequest struct {
	Username string `json:"username"`
	Password string `json:"password"`
	Email    string `json:"email"`
	Admin    bool   `json:"admin"`
	Totp     string `json:"totp"`
}

UserRequest is used for logging in or modifying users