Documentation
¶
Overview ¶
Package api is a thin wrapper over the Miabi /api/v1 HTTP surface, built on github.com/jkaninda/okapi/client. It unwraps the server's {success,data,error} envelope and maps the structured error to a Go error with a stable code.
Index ¶
- Constants
- Variables
- func IsFailure(status string) bool
- func IsTerminal(status string) bool
- type APIError
- type App
- type ApplyFailure
- type ApplyRequest
- type ApplyResult
- type Change
- type Client
- func (c *Client) App(ctx context.Context, ws string, appID uint) (*App, error)
- func (c *Client) Apply(ctx context.Context, ws string, manifests string, prune bool) (*ApplyResult, error)
- func (c *Client) Apps(ctx context.Context, ws string) ([]App, error)
- func (c *Client) ClaimLoginToken(ctx context.Context, code string) (*LoginToken, error)
- func (c *Client) Config(ctx context.Context, ws string, id uint) (*Config, error)
- func (c *Client) ConfigData(ctx context.Context, ws string, id uint) (map[string]string, error)
- func (c *Client) ConfigUsage(ctx context.Context, ws string, id uint) ([]SecretUsage, error)
- func (c *Client) Configs(ctx context.Context, ws string) ([]Config, error)
- func (c *Client) CreateApp(ctx context.Context, ws string, req CreateAppRequest) (*App, error)
- func (c *Client) CreateConfig(ctx context.Context, ws string, req CreateConfigRequest) (*Config, error)
- func (c *Client) CreateDatabase(ctx context.Context, ws string, req CreateDatabaseRequest) (*DatabaseInstance, error)
- func (c *Client) CreateLogicalDatabase(ctx context.Context, ws string, id uint, req CreateLogicalDatabaseRequest) (*CreateLogicalDatabaseResult, error)
- func (c *Client) CreateSecret(ctx context.Context, ws string, req CreateSecretRequest) (*Secret, error)
- func (c *Client) Database(ctx context.Context, ws string, id uint) (*DatabaseInstance, error)
- func (c *Client) DatabaseCredentials(ctx context.Context, ws string, id uint) (*ConnectionInfo, error)
- func (c *Client) DatabaseEngines(ctx context.Context, ws string) ([]EngineDefault, error)
- func (c *Client) Databases(ctx context.Context, ws string) ([]DatabaseInstance, error)
- func (c *Client) Delete(ctx context.Context, ws string, manifests string) (*ApplyResult, error)
- func (c *Client) DeleteApp(ctx context.Context, ws string, appID uint) error
- func (c *Client) DeleteConfig(ctx context.Context, ws string, id uint) error
- func (c *Client) DeleteDatabaseInstance(ctx context.Context, ws string, id uint) error
- func (c *Client) DeleteLogicalDatabase(ctx context.Context, ws string, id, dbID uint) error
- func (c *Client) DeleteSecret(ctx context.Context, ws string, id uint) error
- func (c *Client) Deploy(ctx context.Context, ws string, appID uint, req DeployRequest) (*Deployment, error)
- func (c *Client) Deployment(ctx context.Context, ws string, appID, depID uint) (*Deployment, error)
- func (c *Client) DeploymentByNumber(ctx context.Context, ws string, appID uint, number int) (*Deployment, error)
- func (c *Client) Deployments(ctx context.Context, ws string, appID uint) ([]Deployment, error)
- func (c *Client) EnvVars(ctx context.Context, ws string, appID uint) ([]EnvVar, error)
- func (c *Client) FindConfigByName(ctx context.Context, ws, name string) (*Config, error)
- func (c *Client) FindSecretByName(ctx context.Context, ws, name string) (*Secret, error)
- func (c *Client) ImportEnv(ctx context.Context, ws string, appID uint, req ImportEnvRequest) error
- func (c *Client) LogicalDatabaseConnection(ctx context.Context, ws string, id, dbID uint) (*ConnectionInfo, error)
- func (c *Client) LogicalDatabases(ctx context.Context, ws string, id uint) ([]LogicalDatabase, error)
- func (c *Client) Me(ctx context.Context) (*Me, error)
- func (c *Client) PlanApply(ctx context.Context, ws string, manifests string, prune bool) (*Plan, error)
- func (c *Client) PlanDelete(ctx context.Context, ws string, manifests string) (*Plan, error)
- func (c *Client) ReleaseByVersion(ctx context.Context, ws string, appID uint, version int) (*Release, error)
- func (c *Client) Releases(ctx context.Context, ws string, appID uint) ([]Release, error)
- func (c *Client) ResolveAppID(ctx context.Context, ws string, ref string) (uint, error)
- func (c *Client) ResolveConfigID(ctx context.Context, ws, ref string) (uint, error)
- func (c *Client) ResolveDatabaseID(ctx context.Context, ws, ref string) (uint, error)
- func (c *Client) ResolveSecretID(ctx context.Context, ws, ref string) (uint, error)
- func (c *Client) ResolveWorkspaceName(ctx context.Context, ref, fallback string) (string, error)
- func (c *Client) RestartApp(ctx context.Context, ws string, appID uint) error
- func (c *Client) RestartDatabase(ctx context.Context, ws string, id uint) error
- func (c *Client) ResyncAppPipeline(ctx context.Context, ws string, appID uint) (*ResyncPipelineResult, error)
- func (c *Client) RevealSecret(ctx context.Context, ws string, id uint) (string, error)
- func (c *Client) Rollback(ctx context.Context, ws string, appID uint, req RollbackRequest) (*Deployment, error)
- func (c *Client) SecretUsage(ctx context.Context, ws string, id uint) ([]SecretUsage, error)
- func (c *Client) Secrets(ctx context.Context, ws string) ([]Secret, error)
- func (c *Client) SetAppSource(ctx context.Context, ws string, appID uint, req SetAppSourceRequest) (*SetAppSourceResult, error)
- func (c *Client) SetEnv(ctx context.Context, ws string, appID uint, req SetEnvRequest) error
- func (c *Client) StartApp(ctx context.Context, ws string, appID uint) error
- func (c *Client) StartDatabase(ctx context.Context, ws string, id uint) error
- func (c *Client) StopApp(ctx context.Context, ws string, appID uint) error
- func (c *Client) StopDatabase(ctx context.Context, ws string, id uint) error
- func (c *Client) UpdateConfig(ctx context.Context, ws string, id uint, req UpdateConfigRequest) (*Config, error)
- func (c *Client) UpdateSecret(ctx context.Context, ws string, id uint, req UpdateSecretRequest) (*Secret, error)
- func (c *Client) UpgradeDatabase(ctx context.Context, ws string, id uint, req UpgradeDatabaseRequest) (*DatabaseInstance, error)
- func (c *Client) WaitForDeploy(ctx context.Context, ws string, appID, depID uint, ...) (*Deployment, error)
- func (c *Client) Workspaces(ctx context.Context) ([]Workspace, error)
- type Config
- type ConfigReveal
- type ConnectionInfo
- type CreateAppRequest
- type CreateConfigRequest
- type CreateDatabaseRequest
- type CreateLogicalDatabaseRequest
- type CreateLogicalDatabaseResult
- type CreateSecretRequest
- type DatabaseInstance
- type DeployRequest
- type Deployment
- type EngineDefault
- type EnvVar
- type ImportEnvRequest
- type LogicalDatabase
- type LoginToken
- type Me
- type Options
- type Plan
- type Release
- type ResyncPipelineResult
- type RollbackRequest
- type Secret
- type SecretReveal
- type SecretUsage
- type SetAppSourceRequest
- type SetAppSourceResult
- type SetEnvRequest
- type SourceChange
- type UpdateConfigRequest
- type UpdateSecretRequest
- type UpgradeDatabaseRequest
- type Workspace
Constants ¶
const ( StatusSucceeded = "succeeded" StatusRunning = "running" // legacy terminal success StatusFailed = "failed" )
Deploy-status classification. The server treats succeeded (and the legacy "running") as terminal success and "failed" as terminal failure; everything else is in-progress.
Variables ¶
var Version = "dev"
Version is stamped at build time (see .goreleaser.yaml); used in User-Agent.
Functions ¶
func IsTerminal ¶
IsTerminal reports whether a deployment status will not change further.
Types ¶
type APIError ¶
type APIError struct {
StatusCode int `json:"status_code"`
Code string `json:"code"`
Message string `json:"message"`
Detail string `json:"error"`
}
APIError is the server's structured error envelope.
type App ¶
type App struct {
ID uint `json:"id"`
Name string `json:"name"`
DisplayName string `json:"display_name"`
Image string `json:"image"`
Tag string `json:"tag"`
// SourceType is "image" or "git" — what the app builds from.
SourceType string `json:"source_type"`
GitRepo string `json:"git_repo,omitempty"`
GitRef string `json:"git_ref,omitempty"`
Status string `json:"status"`
CurrentReleaseID *uint `json:"current_release_id"`
CreatedAt time.Time `json:"created_at"`
}
App is an application listing/detail (only the fields the CLI surfaces). Name is the unique handle; DisplayName is the free-text label.
type ApplyFailure ¶
type ApplyFailure struct {
Kind string `json:"kind"`
Name string `json:"name"`
Action string `json:"action"`
Error string `json:"error"`
}
ApplyFailure is one resource that failed to converge.
type ApplyRequest ¶
type ApplyRequest struct {
Manifests string `json:"manifests"`
Prune bool `json:"prune"`
DryRun bool `json:"dry_run"`
// Delete removes exactly the resources the bundle names instead of converging.
Delete bool `json:"delete,omitempty"`
}
ApplyRequest is the body of POST .../apply — a miabi.io/v1 manifest bundle and the converge options.
type ApplyResult ¶
type ApplyResult struct {
Plan *Plan `json:"plan"`
Applied int `json:"applied"`
DryRun bool `json:"dry_run"`
Failures []ApplyFailure `json:"failures,omitempty"`
}
ApplyResult is what a non-dry-run apply returns.
type Change ¶
type Change struct {
Action string `json:"action"` // create | update | delete | noop
Kind string `json:"kind"`
Name string `json:"name"`
Reason string `json:"reason,omitempty"`
}
Change is one planned operation on a resource.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client talks to one panel with one token.
func New ¶
New builds a client from o. It returns an error only when a configured CA bundle cannot be read or parsed — a misconfigured trust root should fail loudly rather than silently fall back to the system roots.
func (*Client) Apply ¶
func (c *Client) Apply(ctx context.Context, ws string, manifests string, prune bool) (*ApplyResult, error)
Apply converges the workspace to the manifest bundle.
func (*Client) ClaimLoginToken ¶ added in v0.10.0
ClaimLoginToken exchanges a single-use hand-off code (delivered to the CLI's loopback callback by the browser login flow) for the minted token. The endpoint is public — the code is itself the short-lived, one-time credential — so this works on a client built without a token.
func (*Client) ConfigData ¶ added in v0.10.0
ConfigData returns a config's decrypted files (admin only, audited).
func (*Client) ConfigUsage ¶ added in v0.10.0
func (*Client) Configs ¶ added in v0.10.0
Configs lists a workspace's configs (keys and digests, never content).
func (*Client) CreateConfig ¶ added in v0.10.0
func (*Client) CreateDatabase ¶ added in v0.10.0
func (c *Client) CreateDatabase(ctx context.Context, ws string, req CreateDatabaseRequest) (*DatabaseInstance, error)
func (*Client) CreateLogicalDatabase ¶ added in v0.10.0
func (c *Client) CreateLogicalDatabase(ctx context.Context, ws string, id uint, req CreateLogicalDatabaseRequest) (*CreateLogicalDatabaseResult, error)
func (*Client) CreateSecret ¶ added in v0.10.0
func (*Client) DatabaseCredentials ¶ added in v0.10.0
func (*Client) DatabaseEngines ¶ added in v0.10.0
func (*Client) DeleteConfig ¶ added in v0.10.0
func (*Client) DeleteDatabaseInstance ¶ added in v0.10.0
func (*Client) DeleteLogicalDatabase ¶ added in v0.10.0
func (*Client) DeleteSecret ¶ added in v0.10.0
func (*Client) Deploy ¶
func (c *Client) Deploy(ctx context.Context, ws string, appID uint, req DeployRequest) (*Deployment, error)
func (*Client) Deployment ¶
Deployment resolves a single deployment. The API exposes no per-deployment GET route, so it is found within the (recent) deployments list.
func (*Client) DeploymentByNumber ¶ added in v0.10.0
func (c *Client) DeploymentByNumber(ctx context.Context, ws string, appID uint, number int) (*Deployment, error)
DeploymentByNumber resolves a per-application deployment number (the value users pass) to the full deployment, whose durable ID API paths address by.
func (*Client) Deployments ¶
func (*Client) EnvVars ¶ added in v0.10.0
EnvVars lists an application's environment variables. Secret values come back masked — the API never returns them in plaintext.
func (*Client) FindConfigByName ¶ added in v0.10.0
FindConfigByName returns the named config, or nil when none exists (used by `set` to choose between create and replace).
func (*Client) FindSecretByName ¶ added in v0.10.0
FindSecretByName returns the workspace secret with the given name, or nil when none exists (used by `set` to choose between create and rotate).
func (*Client) LogicalDatabaseConnection ¶ added in v0.10.0
func (*Client) LogicalDatabases ¶ added in v0.10.0
func (*Client) PlanApply ¶
func (c *Client) PlanApply(ctx context.Context, ws string, manifests string, prune bool) (*Plan, error)
PlanApply previews converging the workspace to the manifest bundle (dry-run).
func (*Client) PlanDelete ¶
PlanDelete previews deleting exactly the resources the bundle names (dry-run).
func (*Client) ReleaseByVersion ¶ added in v0.10.0
func (c *Client) ReleaseByVersion(ctx context.Context, ws string, appID uint, version int) (*Release, error)
ReleaseByVersion resolves a per-application release version to the full release (the ID is what the rollback API expects).
func (*Client) ResolveAppID ¶
ResolveAppID turns an app handle (or numeric id) into the numeric id paths use.
func (*Client) ResolveConfigID ¶ added in v0.10.0
ResolveConfigID turns a config name (or numeric id) into its numeric id.
func (*Client) ResolveDatabaseID ¶ added in v0.10.0
ResolveDatabaseID turns a database handle (or numeric id) into the numeric id.
func (*Client) ResolveSecretID ¶ added in v0.10.0
ResolveSecretID turns a secret name (or numeric id) into its numeric id.
func (*Client) ResolveWorkspaceName ¶ added in v0.10.0
ResolveWorkspaceName turns a user-supplied workspace reference into the canonical name (handle) the API addresses by. ref may be the name, a UID, or a numeric id (resolved to its name for back-compat); an empty ref falls back to fallback (the persisted/bound workspace) and finally to the sole workspace the caller can see. The returned value is always a name, since scoped routes are addressed by name.
func (*Client) RestartApp ¶ added in v0.10.0
func (*Client) RestartDatabase ¶ added in v0.10.0
func (*Client) ResyncAppPipeline ¶ added in v0.10.0
func (c *Client) ResyncAppPipeline(ctx context.Context, ws string, appID uint) (*ResyncPipelineResult, error)
ResyncAppPipeline reloads the repository's pipelines.yaml: adopting one when the app has none, and re-syncing the stored spec when it already has one.
func (*Client) RevealSecret ¶ added in v0.10.0
RevealSecret returns a secret's decrypted value (admin only, audited).
func (*Client) Rollback ¶
func (c *Client) Rollback(ctx context.Context, ws string, appID uint, req RollbackRequest) (*Deployment, error)
func (*Client) SecretUsage ¶ added in v0.10.0
func (*Client) Secrets ¶ added in v0.10.0
Secrets lists a workspace's secrets (names + metadata, never values). The list endpoint is paginated; a large page size fetches them in one call.
func (*Client) SetAppSource ¶ added in v0.10.0
func (c *Client) SetAppSource(ctx context.Context, ws string, appID uint, req SetAppSourceRequest) (*SetAppSourceResult, error)
SetAppSource replaces where an app's image comes from, including switching between a prebuilt image and a Git build. It is a whole-source replacement: the server clears the fields belonging to the source being left, so a partial request would leave the app describing both.
func (*Client) StartDatabase ¶ added in v0.10.0
func (*Client) StopDatabase ¶ added in v0.10.0
func (*Client) UpdateConfig ¶ added in v0.10.0
func (*Client) UpdateSecret ¶ added in v0.10.0
func (*Client) UpgradeDatabase ¶ added in v0.10.0
func (c *Client) UpgradeDatabase(ctx context.Context, ws string, id uint, req UpgradeDatabaseRequest) (*DatabaseInstance, error)
func (*Client) WaitForDeploy ¶
func (c *Client) WaitForDeploy(ctx context.Context, ws string, appID, depID uint, onUpdate func(status string)) (*Deployment, error)
WaitForDeploy polls a deployment until it reaches a terminal state or the context is cancelled/times out, calling onUpdate (if non-nil) on each status change. It returns the final deployment.
type Config ¶ added in v0.10.0
type Config struct {
ID uint `json:"id"`
UID string `json:"uid"`
Name string `json:"name"`
DisplayName string `json:"display_name"`
Description string `json:"description"`
Digest string `json:"digest"`
Mode string `json:"mode"`
Sensitive bool `json:"sensitive"`
Delimiters []string `json:"delimiters,omitempty"`
Version int `json:"version"`
Managed bool `json:"managed"`
Keys []string `json:"keys"`
Sizes map[string]int `json:"sizes"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
}
Config is a workspace configuration file set. Content never comes back on a list or get — only keys, their sizes and the digest.
type ConfigReveal ¶ added in v0.10.0
ConfigReveal is the decrypted file set (admin only, audited).
type ConnectionInfo ¶ added in v0.10.0
type ConnectionInfo struct {
Host string `json:"host"`
Port int `json:"port"`
Username string `json:"username"`
Password string `json:"password"`
Database string `json:"database"`
URI string `json:"uri"`
}
ConnectionInfo is a revealed database connection (admin credentials / DSN).
type CreateAppRequest ¶ added in v0.10.0
type CreateAppRequest struct {
DisplayName string `json:"display_name"`
Name string `json:"name,omitempty"`
ServerID uint `json:"server_id,omitempty"`
SourceType string `json:"source_type,omitempty"`
Image string `json:"image,omitempty"`
Tag string `json:"tag,omitempty"`
GitRepo string `json:"git_repo,omitempty"`
GitRef string `json:"git_ref,omitempty"`
BuildMethod string `json:"build_method,omitempty"`
Port int `json:"port,omitempty"`
Command []string `json:"command,omitempty"`
}
CreateAppRequest is the body of POST .../apps (only the common fields the CLI exposes). SourceType is "image" or "git"; the CLI infers it from the flags. DisplayName is the required free-text label; Name pins the handle (the server otherwise derives it from DisplayName).
type CreateConfigRequest ¶ added in v0.10.0
type CreateConfigRequest struct {
Name string `json:"name"`
DisplayName string `json:"display_name,omitempty"`
Description string `json:"description,omitempty"`
Data map[string]string `json:"data"`
Mode string `json:"mode,omitempty"`
Sensitive bool `json:"sensitive,omitempty"`
Delimiters []string `json:"delimiters,omitempty"`
}
type CreateDatabaseRequest ¶ added in v0.10.0
type CreateDatabaseRequest struct {
Name string `json:"name"`
Engine string `json:"engine"`
Version string `json:"version,omitempty"`
ServerID uint `json:"server_id,omitempty"`
SizeMB int `json:"size_mb,omitempty"`
}
CreateDatabaseRequest is the body of POST .../databases.
type CreateLogicalDatabaseRequest ¶ added in v0.10.0
type CreateLogicalDatabaseRequest struct {
Name string `json:"name"`
ApplicationID *uint `json:"application_id"`
}
CreateLogicalDatabaseRequest is the body of POST .../databases/{id}/databases.
type CreateLogicalDatabaseResult ¶ added in v0.10.0
type CreateLogicalDatabaseResult struct {
Database LogicalDatabase `json:"database"`
EnvInjected bool `json:"env_injected"`
}
CreateLogicalDatabaseResult is the create-logical-database response.
type CreateSecretRequest ¶ added in v0.10.0
type CreateSecretRequest struct {
Name string `json:"name"`
Value string `json:"value"`
Description string `json:"description,omitempty"`
}
CreateSecretRequest is the body of POST .../secrets.
type DatabaseInstance ¶ added in v0.10.0
type DatabaseInstance struct {
ID uint `json:"id"`
Name string `json:"name"`
DisplayName string `json:"display_name"`
Engine string `json:"engine"`
Version string `json:"version"`
Status string `json:"status"`
ServerID uint `json:"server_id"`
ServerName string `json:"server_name,omitempty"`
Host string `json:"host"`
Port int `json:"port"`
AdminUser string `json:"admin_user"`
SizeBytes int64 `json:"size_bytes,omitempty"`
NetworkName string `json:"network_name,omitempty"`
CreatedAt time.Time `json:"created_at"`
}
DatabaseInstance is a managed database server (only the fields the CLI shows). Name is the unique handle; DisplayName is the free-text label.
type DeployRequest ¶
type DeployRequest struct {
Tag string `json:"tag,omitempty"`
Strategy string `json:"strategy,omitempty"`
RegistryID *uint `json:"registry_id,omitempty"`
}
DeployRequest is the body of POST .../deploy. image is not part of the deploy contract (the app owns its image); only a tag/registry/strategy override.
type Deployment ¶
type Deployment struct {
ID uint `json:"id"`
// Number is the per-application deployment number (1, 2, 3…) users address
// deployments by; ID is the durable platform-wide key used in API paths.
Number int `json:"number"`
ApplicationID uint `json:"application_id"`
Status string `json:"status"`
Image string `json:"image"`
Trigger string `json:"trigger"`
Strategy string `json:"strategy"`
Error string `json:"error"`
StartedAt *time.Time `json:"started_at"`
FinishedAt *time.Time `json:"finished_at"`
CreatedAt time.Time `json:"created_at"`
// Current marks the deployment whose release is live right now.
Current bool `json:"current"`
}
Deployment is the deploy/rollback response and status object.
type EngineDefault ¶ added in v0.10.0
type EngineDefault struct {
Engine string `json:"engine"`
Image string `json:"image"`
Version string `json:"version"`
}
EngineDefault is one entry of GET /database-engines.
type EnvVar ¶ added in v0.10.0
type EnvVar struct {
Key string `json:"key"`
Value string `json:"value"`
IsSecret bool `json:"is_secret"`
}
EnvVar is one of an application's environment variables. The server masks the value of a secret var, so Value is never the plaintext for those.
type ImportEnvRequest ¶
ImportEnvRequest is the body of POST .../env/import.
type LogicalDatabase ¶ added in v0.10.0
type LogicalDatabase struct {
ID uint `json:"id"`
InstanceID uint `json:"instance_id"`
Name string `json:"name"`
Username string `json:"username"`
Status string `json:"status"`
ApplicationID *uint `json:"application_id"`
EnvPrefix string `json:"env_prefix,omitempty"`
SizeBytes int64 `json:"size_bytes,omitempty"`
CreatedAt time.Time `json:"created_at"`
}
LogicalDatabase is a database hosted on an instance (SQL engines).
type LoginToken ¶ added in v0.10.0
type LoginToken struct {
Token string `json:"token"`
ServerURL string `json:"server_url"`
ExpiresAt string `json:"expires_at"`
}
LoginToken is the minted CLI token returned by the login-token claim endpoint (the browser hands off a single-use code; this is what it exchanges to).
type Me ¶
type Me struct {
ID uint `json:"id"`
Name string `json:"name"`
Username string `json:"username"`
Email string `json:"email"`
Role string `json:"role"`
Auth struct {
Method string `json:"method"` // api_key | jwt
APIKeyID *uint `json:"api_key_id"` // when method=api_key
WorkspaceID *uint `json:"workspace_id"` // set only for workspace-bound keys
Scopes []string `json:"scopes"`
} `json:"auth"`
}
Me is GET /api/v1/me — the authenticated identity and, for an API key, its scopes and bound workspace.
type Options ¶ added in v0.10.0
Options configures a client: the server base URL, bearer token, TLS trust (a custom CA bundle path and/or skip-verify), and verbose HTTP logging.
type Plan ¶
type Plan struct {
Changes []Change `json:"changes"`
}
Plan is what a dry-run apply returns.
type Release ¶
type Release struct {
ID uint `json:"id"`
ApplicationID uint `json:"application_id"`
DeploymentID uint `json:"deployment_id"`
Version int `json:"version"`
Image string `json:"image"`
Active bool `json:"active"`
Digest *string `json:"digest"`
CreatedAt time.Time `json:"created_at"`
}
Release is one immutable release of an app.
type ResyncPipelineResult ¶ added in v0.10.0
type ResyncPipelineResult struct {
Pipeline *struct {
Name string `json:"name"`
SourcePath string `json:"source_path"`
SourceRef string `json:"source_ref"`
} `json:"pipeline"`
Changed bool `json:"changed"`
Adopted bool `json:"adopted"`
}
ResyncPipelineResult reports the pipeline the app ended up bound to. Changed is false when the repository's document already matched what was stored — a successful no-op, not a failure.
type RollbackRequest ¶
type RollbackRequest struct {
ReleaseID uint `json:"release_id"`
}
RollbackRequest is the body of POST .../rollback.
type Secret ¶ added in v0.10.0
type Secret struct {
ID uint `json:"id"`
UID string `json:"uid"`
Name string `json:"name"`
DisplayName string `json:"display_name"`
Description string `json:"description"`
// Version bumps on each value rotation.
Version int `json:"version"`
// Managed marks a secret owned by a platform resource (e.g. a managed
// database); rotate it via its owner, not by hand.
Managed bool `json:"managed"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
}
Secret is one entry of the workspace Vault. Values are write-only over the API and never appear here — reveal them explicitly (admin-only, audited). Name is the unique handle env refs use (${{ secrets.NAME }}); DisplayName is a label.
type SecretReveal ¶ added in v0.10.0
type SecretReveal struct {
Value string `json:"value"`
}
SecretReveal is the payload of GET .../secrets/{id}/reveal.
type SecretUsage ¶ added in v0.10.0
SecretUsage is one app referencing a secret (GET .../secrets/{id}/usage).
type SetAppSourceRequest ¶ added in v0.10.0
type SetAppSourceRequest struct {
SourceType string `json:"source_type"`
Image string `json:"image,omitempty"`
Tag string `json:"tag,omitempty"`
RegistryID *uint `json:"registry_id,omitempty"`
GitRepo string `json:"git_repo,omitempty"`
GitRef string `json:"git_ref,omitempty"`
GitRepositoryID *uint `json:"git_repository_id,omitempty"`
BuildMethod string `json:"build_method,omitempty"`
Builder string `json:"builder,omitempty"`
}
SetAppSourceRequest is a whole-source replacement. Only the fields of the chosen source_type are read; the server clears the other source's.
type SetAppSourceResult ¶ added in v0.10.0
type SetAppSourceResult struct {
Application App `json:"application"`
Change SourceChange `json:"change"`
}
type SetEnvRequest ¶
type SetEnvRequest struct {
Key string `json:"key"`
Value string `json:"value"`
IsSecret bool `json:"is_secret"`
}
SetEnvRequest is the body of PUT .../env.
type SourceChange ¶ added in v0.10.0
type SourceChange struct {
From string `json:"from"`
To string `json:"to"`
// Switched is false when only the details changed (a new tag, a different branch).
Switched bool `json:"switched"`
// PipelineRemoved is true when leaving git dropped a repo-owned pipeline.
PipelineRemoved bool `json:"pipeline_removed"`
// RedeployRequired is true when the running container no longer matches the source.
RedeployRequired bool `json:"redeploy_required"`
}
SourceChange reports what else moved when the source changed. None of it is visible in the app record afterwards, so it is worth surfacing.
type UpdateConfigRequest ¶ added in v0.10.0
type UpdateSecretRequest ¶ added in v0.10.0
type UpdateSecretRequest struct {
Value string `json:"value"`
Description string `json:"description"`
}
UpdateSecretRequest is the body of PUT .../secrets/{id}. A blank Value keeps the stored value (a description-only edit); a new value rotates the secret.
type UpgradeDatabaseRequest ¶ added in v0.10.0
type UpgradeDatabaseRequest struct {
Version string `json:"version"`
StopApps bool `json:"stop_apps,omitempty"`
}
UpgradeDatabaseRequest is the body of POST .../databases/{id}/upgrade.