api

Documentation

Index

• Constants
• type AgentInfo
• type AgentMeta
• type AgentToken
• type GitalyInfo
• type ProjectInfo

Constants

const (
	ProjectId = "project_id"
	ClusterId = "cluster_id"
	AgentId   = "agent_id"

	ResourceKey = "resource_key"
	SyncResult  = "sync_result"
)

Logging field names. Are here for consistency across codebase.

const (
	MetadataAuthorization = "authorization"
)

Types

type AgentInfo

type AgentInfo struct {
	Meta AgentMeta
	// ID is the agent's id in the database.
	ID int64
	// ProjectID is the id of the configuration project of the agent.
	ProjectID int64

	// Name is the agent's name.
	// Can contain only /a-z\d-/
	Name       string
	GitalyInfo GitalyInfo
	Repository gitalypb.Repository
}

AgentInfo contains information about an agentk.

type AgentMeta

type AgentMeta struct {
	Token AgentToken
}

AgentMeta contains information received from agentk with a request. It's passed as gRPC metadata.

type AgentToken

type AgentToken string

AgentToken is agentk's bearer access token.

type GitalyInfo

type GitalyInfo struct {
	Address  string
	Token    string
	Features map[string]string
}

type ProjectInfo

type ProjectInfo struct {
	ProjectID  int64
	GitalyInfo GitalyInfo
	Repository gitalypb.Repository
}