portainer

type APIKey struct {
	ID          APIKeyID `json:"id" example:"1"`
	UserID      UserID   `json:"userId" example:"1"`
	Description string   `json:"description" example:"portainer-api-key"`
	Prefix      string   `json:"prefix"`           // API key identifier (7 char prefix)
	DateCreated int64    `json:"dateCreated"`      // Unix timestamp (UTC) when the API key was created
	LastUsed    int64    `json:"lastUsed"`         // Unix timestamp (UTC) when the API key was last used
	Digest      []byte   `json:"digest,omitempty"` // Digest represents SHA256 hash of the raw API key
}

type APIKeyID int

type AccessPolicy struct {
	// Role identifier. Reference the role that will be associated to this access policy
	RoleID RoleID `json:"RoleId" example:"1"`
}

type AgentPlatform int

type AuthenticationMethod int

type Authorization string

type Authorizations map[Authorization]bool

type AutoUpdateSettings struct {
	// Auto update interval
	Interval string `example:"1m30s"`
	// A UUID generated from client
	Webhook string `example:"05de31a2-79fa-4644-9c12-faa67e5c49f0"`
	// Autoupdate job id
	JobID string `example:"15"`
	// Force update ignores repo changes
	ForceUpdate bool `example:"false"`
	// Pull latest image
	ForcePullImage bool `example:"false"`
}

type AzureCredentials struct {
	// Azure application ID
	ApplicationID string `json:"ApplicationID" example:"eag7cdo9-o09l-9i83-9dO9-f0b23oe78db4"`
	// Azure tenant ID
	TenantID string `json:"TenantID" example:"34ddc78d-4fel-2358-8cc1-df84c8o839f5"`
	// Azure authentication key
	AuthenticationKey string `json:"AuthenticationKey" example:"cOrXoK/1D35w8YQ8nH1/8ZGwzz45JIYD5jxHKXEQknk="`
}

type CLIFlags struct {
	Addr                      *string
	AddrHTTPS                 *string
	TunnelAddr                *string
	TunnelPort                *string
	AdminPassword             *string
	AdminPasswordFile         *string
	Assets                    *string
	Data                      *string
	FeatureFlags              *[]string
	DemoEnvironment           *bool
	EnableEdgeComputeFeatures *bool
	EndpointURL               *string
	Labels                    *[]Pair
	Logo                      *string
	NoAnalytics               *bool
	Templates                 *string
	TLS                       *bool
	TLSSkipVerify             *bool
	TLSCacert                 *string
	TLSCert                   *string
	TLSKey                    *string
	HTTPDisabled              *bool
	HTTPEnabled               *bool
	SSL                       *bool
	SSLCert                   *string
	SSLKey                    *string
	Rollback                  *bool
	SnapshotInterval          *string
	BaseURL                   *string
	InitialMmapSize           *int
	MaxBatchSize              *int
	MaxBatchDelay             *time.Duration
	SecretKeyName             *string
	LogLevel                  *string
	LogMode                   *string
}

type CLIService interface {
	ParseFlags(version string) (*CLIFlags, error)
	ValidateFlags(flags *CLIFlags) error
}

type ComposeStackManager interface {
	ComposeSyntaxMaxVersion() string
	NormalizeStackName(name string) string
	Up(ctx context.Context, stack *Stack, endpoint *Endpoint, forceRecreate bool) error
	Down(ctx context.Context, stack *Stack, endpoint *Endpoint) error
	Pull(ctx context.Context, stack *Stack, endpoint *Endpoint) error
}

type Connection interface {
	Transaction

	Open() error
	Close() error

	UpdateTx(fn func(Transaction) error) error
	ViewTx(fn func(Transaction) error) error

	// write the db contents to filename as json (the schema needs defining)
	ExportRaw(filename string) error

	// TODO: this one is very database specific atm
	BackupTo(w io.Writer) error
	GetDatabaseFileName() string
	GetDatabaseFilePath() string
	GetStorePath() string

	IsEncryptedStore() bool
	NeedsEncryptionMigration() (bool, error)
	SetEncrypted(encrypted bool)

	BackupMetadata() (map[string]interface{}, error)
	RestoreMetadata(s map[string]interface{}) error

	UpdateObjectFunc(bucketName string, key []byte, object any, updateFn func()) error
	ConvertToKey(v int) []byte
}

type CryptoService interface {
	Hash(data string) (string, error)
	CompareHashAndData(hash string, data string) error
}

type CustomTemplate struct {
	// CustomTemplate Identifier
	ID CustomTemplateID `json:"Id" example:"1"`
	// Title of the template
	Title string `json:"Title" example:"Nginx"`
	// Description of the template
	Description string `json:"Description" example:"High performance web server"`
	// Path on disk to the repository hosting the Stack file
	ProjectPath string `json:"ProjectPath" example:"/data/custom_template/3"`
	// Path to the Stack file
	EntryPoint string `json:"EntryPoint" example:"docker-compose.yml"`
	// User identifier who created this template
	CreatedByUserID UserID `json:"CreatedByUserId" example:"3"`
	// A note that will be displayed in the UI. Supports HTML content
	Note string `json:"Note" example:"This is my <b>custom</b> template"`
	// Platform associated to the template.
	// Valid values are: 1 - 'linux', 2 - 'windows'
	Platform CustomTemplatePlatform `json:"Platform" example:"1" enums:"1,2"`
	// URL of the template's logo
	Logo string `json:"Logo" example:"https://portainer.io/img/logo.svg"`
	// Type of created stack:
	// * 1 - swarm
	// * 2 - compose
	// * 3 - kubernetes
	Type            StackType        `json:"Type" example:"1" enums:"1,2,3"`
	ResourceControl *ResourceControl `json:"ResourceControl"`
	Variables       []CustomTemplateVariableDefinition
	GitConfig       *gittypes.RepoConfig `json:"GitConfig"`
	// IsComposeFormat indicates if the Kubernetes template is created from a Docker Compose file
	IsComposeFormat bool `example:"false"`
}

type CustomTemplateID int

type CustomTemplatePlatform int

type CustomTemplateVariableDefinition struct {
	Name         string `json:"name" example:"MY_VAR"`
	Label        string `json:"label" example:"My Variable"`
	DefaultValue string `json:"defaultValue" example:"default value"`
	Description  string `json:"description" example:"Description"`
}

type DigitalSignatureService interface {
	ParseKeyPair(private, public []byte) error
	GenerateKeyPair() ([]byte, []byte, error)
	EncodedPublicKey() string
	PEMHeaders() (string, string)
	CreateSignature(message string) (string, error)
}

type DockerContainerSnapshot struct {
	types.Container
	Env []string `json:"Env,omitempty"` // EE-5240
}

type DockerHub struct {
	// Is authentication against DockerHub enabled
	Authentication bool `json:"Authentication" example:"true"`
	// Username used to authenticate against the DockerHub
	Username string `json:"Username" example:"user"`
	// Password used to authenticate against the DockerHub
	Password string `json:"Password,omitempty" example:"passwd"`
}

type DockerSnapshot struct {
	Time                    int64             `json:"Time"`
	DockerVersion           string            `json:"DockerVersion"`
	Swarm                   bool              `json:"Swarm"`
	TotalCPU                int               `json:"TotalCPU"`
	TotalMemory             int64             `json:"TotalMemory"`
	RunningContainerCount   int               `json:"RunningContainerCount"`
	StoppedContainerCount   int               `json:"StoppedContainerCount"`
	HealthyContainerCount   int               `json:"HealthyContainerCount"`
	UnhealthyContainerCount int               `json:"UnhealthyContainerCount"`
	VolumeCount             int               `json:"VolumeCount"`
	ImageCount              int               `json:"ImageCount"`
	ServiceCount            int               `json:"ServiceCount"`
	StackCount              int               `json:"StackCount"`
	SnapshotRaw             DockerSnapshotRaw `json:"DockerSnapshotRaw"`
	NodeCount               int               `json:"NodeCount"`
	GpuUseAll               bool              `json:"GpuUseAll"`
	GpuUseList              []string          `json:"GpuUseList"`
}

type DockerSnapshotRaw struct {
	Containers []DockerContainerSnapshot `json:"Containers" swaggerignore:"true"`
	Volumes    volume.VolumeListOKBody   `json:"Volumes" swaggerignore:"true"`
	Networks   []types.NetworkResource   `json:"Networks" swaggerignore:"true"`
	Images     []types.ImageSummary      `json:"Images" swaggerignore:"true"`
	Info       types.Info                `json:"Info" swaggerignore:"true"`
	Version    types.Version             `json:"Version" swaggerignore:"true"`
}

type DockerSnapshotter interface {
	CreateSnapshot(endpoint *Endpoint) (*DockerSnapshot, error)
}

type EcrData struct {
	Region string `json:"Region" example:"ap-southeast-2"`
}

type EdgeGroup struct {
	// EdgeGroup Identifier
	ID           EdgeGroupID  `json:"Id" example:"1"`
	Name         string       `json:"Name"`
	Dynamic      bool         `json:"Dynamic"`
	TagIDs       []TagID      `json:"TagIds"`
	Endpoints    []EndpointID `json:"Endpoints"`
	PartialMatch bool         `json:"PartialMatch"`
}

type EdgeGroupID int

type EdgeJob struct {
	// EdgeJob Identifier
	ID             EdgeJobID                          `json:"Id" example:"1"`
	Created        int64                              `json:"Created"`
	CronExpression string                             `json:"CronExpression"`
	Endpoints      map[EndpointID]EdgeJobEndpointMeta `json:"Endpoints"`
	EdgeGroups     []EdgeGroupID                      `json:"EdgeGroups"`
	Name           string                             `json:"Name"`
	ScriptPath     string                             `json:"ScriptPath"`
	Recurring      bool                               `json:"Recurring"`
	Version        int                                `json:"Version"`

	// Field used for log collection of Endpoints belonging to EdgeGroups
	GroupLogsCollection map[EndpointID]EdgeJobEndpointMeta
}

type EdgeJobEndpointMeta struct {
	LogsStatus  EdgeJobLogsStatus
	CollectLogs bool
}

type EdgeJobID int

type EdgeJobLogsStatus int

type EdgeStack struct {
	// EdgeStack Identifier
	ID     EdgeStackID                    `json:"Id" example:"1"`
	Name   string                         `json:"Name"`
	Status map[EndpointID]EdgeStackStatus `json:"Status"`
	// StatusArray    map[EndpointID][]EdgeStackStatus `json:"StatusArray"`
	CreationDate   int64         `json:"CreationDate"`
	EdgeGroups     []EdgeGroupID `json:"EdgeGroups"`
	ProjectPath    string        `json:"ProjectPath"`
	EntryPoint     string        `json:"EntryPoint"`
	Version        int           `json:"Version"`
	NumDeployments int           `json:"NumDeployments"`
	ManifestPath   string
	DeploymentType EdgeStackDeploymentType
	// Uses the manifest's namespaces instead of the default one
	UseManifestNamespaces bool

	// Deprecated
	Prune bool `json:"Prune"`
}

type EdgeStackDeploymentStatus struct {
	Time  int64
	Type  EdgeStackStatusType
	Error string
	// EE only feature
	RollbackTo *int
}

type EdgeStackDeploymentType int

type EdgeStackID int

type EdgeStackStatus struct {
	Status     []EdgeStackDeploymentStatus
	EndpointID EndpointID
	// EE only feature
	DeploymentInfo StackDeploymentInfo

	// Deprecated
	Details EdgeStackStatusDetails
	// Deprecated
	Error string
	// Deprecated
	Type EdgeStackStatusType `json:"Type"`
}

type EdgeStackStatusDetails struct {
	Pending             bool
	Ok                  bool
	Error               bool
	Acknowledged        bool
	Remove              bool
	RemoteUpdateSuccess bool
	ImagesPulled        bool
}

type EdgeStackStatusType int

type Endpoint struct {
	// Environment(Endpoint) Identifier
	ID EndpointID `json:"Id" example:"1"`
	// Environment(Endpoint) name
	Name string `json:"Name" example:"my-environment"`
	// Environment(Endpoint) environment(endpoint) type. 1 for a Docker environment(endpoint), 2 for an agent on Docker environment(endpoint) or 3 for an Azure environment(endpoint).
	Type EndpointType `json:"Type" example:"1"`
	// URL or IP address of the Docker host associated to this environment(endpoint)
	URL string `json:"URL" example:"docker.mydomain.tld:2375"`
	// Environment(Endpoint) group identifier
	GroupID EndpointGroupID `json:"GroupId" example:"1"`
	// URL or IP address where exposed containers will be reachable
	PublicURL        string           `json:"PublicURL" example:"docker.mydomain.tld:2375"`
	Gpus             []Pair           `json:"Gpus"`
	TLSConfig        TLSConfiguration `json:"TLSConfig"`
	AzureCredentials AzureCredentials `json:"AzureCredentials,omitempty"`
	// List of tag identifiers to which this environment(endpoint) is associated
	TagIDs []TagID `json:"TagIds"`
	// The status of the environment(endpoint) (1 - up, 2 - down)
	Status EndpointStatus `json:"Status" example:"1"`
	// List of snapshots
	Snapshots []DockerSnapshot `json:"Snapshots"`
	// List of user identifiers authorized to connect to this environment(endpoint)
	UserAccessPolicies UserAccessPolicies `json:"UserAccessPolicies"`
	// List of team identifiers authorized to connect to this environment(endpoint)
	TeamAccessPolicies TeamAccessPolicies `json:"TeamAccessPolicies"`
	// The identifier of the edge agent associated with this environment(endpoint)
	EdgeID string `json:"EdgeID,omitempty"`
	// The key which is used to map the agent to Portainer
	EdgeKey string `json:"EdgeKey"`
	// The check in interval for edge agent (in seconds)
	EdgeCheckinInterval int `json:"EdgeCheckinInterval" example:"5"`
	// Associated Kubernetes data
	Kubernetes KubernetesData `json:"Kubernetes"`
	// Maximum version of docker-compose
	ComposeSyntaxMaxVersion string `json:"ComposeSyntaxMaxVersion" example:"3.8"`
	// Environment(Endpoint) specific security settings
	SecuritySettings EndpointSecuritySettings
	// The identifier of the AMT Device associated with this environment(endpoint)
	AMTDeviceGUID string `json:"AMTDeviceGUID,omitempty" example:"4c4c4544-004b-3910-8037-b6c04f504633"`
	// LastCheckInDate mark last check-in date on checkin
	LastCheckInDate int64
	// QueryDate of each query with the endpoints list
	QueryDate int64
	// Heartbeat indicates the heartbeat status of an edge environment
	Heartbeat bool `json:"Heartbeat" example:"true"`

	// Whether the device has been trusted or not by the user
	UserTrusted bool

	// Whether we need to run any "post init migrations".
	PostInitMigrations EndpointPostInitMigrations `json:"PostInitMigrations"`

	Edge EnvironmentEdgeSettings

	Agent struct {
		Version string `example:"1.0.0"`
	}

	EnableGPUManagement bool `json:"EnableGPUManagement"`

	// Deprecated fields
	// Deprecated in DBVersion == 4
	TLS           bool   `json:"TLS,omitempty"`
	TLSCACertPath string `json:"TLSCACert,omitempty"`
	TLSCertPath   string `json:"TLSCert,omitempty"`
	TLSKeyPath    string `json:"TLSKey,omitempty"`

	// Deprecated in DBVersion == 18
	AuthorizedUsers []UserID `json:"AuthorizedUsers"`
	AuthorizedTeams []TeamID `json:"AuthorizedTeams"`

	// Deprecated in DBVersion == 22
	Tags []string `json:"Tags"`

	// Deprecated v2.18
	IsEdgeDevice bool
}

type EndpointAuthorizations map[EndpointID]Authorizations

type EndpointGroup struct {
	// Environment(Endpoint) group Identifier
	ID EndpointGroupID `json:"Id" example:"1"`
	// Environment(Endpoint) group name
	Name string `json:"Name" example:"my-environment-group"`
	// Description associated to the environment(endpoint) group
	Description        string             `json:"Description" example:"Environment(Endpoint) group description"`
	UserAccessPolicies UserAccessPolicies `json:"UserAccessPolicies"`
	TeamAccessPolicies TeamAccessPolicies `json:"TeamAccessPolicies"`
	// List of tags associated to this environment(endpoint) group
	TagIDs []TagID `json:"TagIds"`

	// Deprecated fields
	Labels []Pair `json:"Labels"`

	// Deprecated in DBVersion == 18
	AuthorizedUsers []UserID `json:"AuthorizedUsers"`
	AuthorizedTeams []TeamID `json:"AuthorizedTeams"`

	// Deprecated in DBVersion == 22
	Tags []string `json:"Tags"`
}

type EndpointGroupID int

type EndpointID int

type EndpointPostInitMigrations struct {
	MigrateIngresses bool `json:"MigrateIngresses"`
	MigrateGPUs      bool `json:"MigrateGPUs"`
}

type EndpointRelation struct {
	EndpointID EndpointID
	EdgeStacks map[EdgeStackID]bool
}

type EndpointSecuritySettings struct {
	// Whether non-administrator should be able to use bind mounts when creating containers
	AllowBindMountsForRegularUsers bool `json:"allowBindMountsForRegularUsers" example:"false"`
	// Whether non-administrator should be able to use privileged mode when creating containers
	AllowPrivilegedModeForRegularUsers bool `json:"allowPrivilegedModeForRegularUsers" example:"false"`
	// Whether non-administrator should be able to browse volumes
	AllowVolumeBrowserForRegularUsers bool `json:"allowVolumeBrowserForRegularUsers" example:"true"`
	// Whether non-administrator should be able to use the host pid
	AllowHostNamespaceForRegularUsers bool `json:"allowHostNamespaceForRegularUsers" example:"true"`
	// Whether non-administrator should be able to use device mapping
	AllowDeviceMappingForRegularUsers bool `json:"allowDeviceMappingForRegularUsers" example:"true"`
	// Whether non-administrator should be able to manage stacks
	AllowStackManagementForRegularUsers bool `json:"allowStackManagementForRegularUsers" example:"true"`
	// Whether non-administrator should be able to use container capabilities
	AllowContainerCapabilitiesForRegularUsers bool `json:"allowContainerCapabilitiesForRegularUsers" example:"true"`
	// Whether non-administrator should be able to use sysctl settings
	AllowSysctlSettingForRegularUsers bool `json:"allowSysctlSettingForRegularUsers" example:"true"`
	// Whether host management features are enabled
	EnableHostManagementFeatures bool `json:"enableHostManagementFeatures" example:"true"`
}

type EndpointStatus int

type EndpointSyncJob struct{}

type EndpointType int

type EnvironmentEdgeSettings struct {
	// Whether the device has been started in edge async mode
	AsyncMode bool
	// The ping interval for edge agent - used in edge async mode [seconds]
	PingInterval int `json:"PingInterval" example:"60"`
	// The snapshot interval for edge agent - used in edge async mode [seconds]
	SnapshotInterval int `json:"SnapshotInterval" example:"60"`
	// The command list interval for edge agent - used in edge async mode [seconds]
	CommandInterval int `json:"CommandInterval" example:"60"`
}

type Extension struct {
	// Extension Identifier
	ID               ExtensionID        `json:"Id" example:"1"`
	Enabled          bool               `json:"Enabled"`
	Name             string             `json:"Name,omitempty"`
	ShortDescription string             `json:"ShortDescription,omitempty"`
	Description      string             `json:"Description,omitempty"`
	DescriptionURL   string             `json:"DescriptionURL,omitempty"`
	Price            string             `json:"Price,omitempty"`
	PriceDescription string             `json:"PriceDescription,omitempty"`
	Deal             bool               `json:"Deal,omitempty"`
	Available        bool               `json:"Available,omitempty"`
	License          LicenseInformation `json:"License,omitempty"`
	Version          string             `json:"Version"`
	UpdateAvailable  bool               `json:"UpdateAvailable"`
	ShopURL          string             `json:"ShopURL,omitempty"`
	Images           []string           `json:"Images,omitempty"`
	Logo             string             `json:"Logo,omitempty"`
}

type ExtensionID int

type FDOConfiguration struct {
	Enabled       bool   `json:"enabled"`
	OwnerURL      string `json:"ownerURL"`
	OwnerUsername string `json:"ownerUsername"`
	OwnerPassword string `json:"ownerPassword"`
}

type FDOProfile struct {
	ID            FDOProfileID `json:"id"`
	Name          string       `json:"name"`
	FilePath      string       `json:"filePath"`
	NumberDevices int          `json:"numberDevices"`
	DateCreated   int64        `json:"dateCreated"`
}

type FDOProfileID int

type FileService interface {
	GetDockerConfigPath() string
	GetFileContent(trustedRootPath, filePath string) ([]byte, error)
	Copy(fromFilePath string, toFilePath string, deleteIfExists bool) error
	Rename(oldPath, newPath string) error
	RemoveDirectory(directoryPath string) error
	StoreTLSFileFromBytes(folder string, fileType TLSFileType, data []byte) (string, error)
	GetPathForTLSFile(folder string, fileType TLSFileType) (string, error)
	DeleteTLSFile(folder string, fileType TLSFileType) error
	DeleteTLSFiles(folder string) error
	GetStackProjectPath(stackIdentifier string) string
	GetStackProjectPathByVersion(stackIdentifier string, version int, commitHash string) string
	StoreStackFileFromBytes(stackIdentifier, fileName string, data []byte) (string, error)
	StoreStackFileFromBytesByVersion(stackIdentifier, fileName string, version int, data []byte) (string, error)
	UpdateStoreStackFileFromBytes(stackIdentifier, fileName string, data []byte) (string, error)
	RemoveStackFileBackup(stackIdentifier, fileName string) error
	RemoveStackFileBackupByVersion(stackIdentifier string, version int, fileName string) error
	RollbackStackFile(stackIdentifier, fileName string) error
	RollbackStackFileByVersion(stackIdentifier string, version int, fileName string) error
	GetEdgeStackProjectPath(edgeStackIdentifier string) string
	StoreEdgeStackFileFromBytes(edgeStackIdentifier, fileName string, data []byte) (string, error)
	GetEdgeStackProjectPathByVersion(edgeStackIdentifier string, version int, commitHash string) string
	StoreEdgeStackFileFromBytesByVersion(edgeStackIdentifier, fileName string, version int, data []byte) (string, error)
	FormProjectPathByVersion(projectPath string, version int, commitHash string) string
	SafeMoveDirectory(src, dst string) error
	StoreRegistryManagementFileFromBytes(folder, fileName string, data []byte) (string, error)
	KeyPairFilesExist() (bool, error)
	StoreKeyPair(private, public []byte, privatePEMHeader, publicPEMHeader string) error
	LoadKeyPair() ([]byte, []byte, error)
	WriteJSONToFile(path string, content interface{}) error
	FileExists(path string) (bool, error)
	StoreEdgeJobFileFromBytes(identifier string, data []byte) (string, error)
	GetEdgeJobFolder(identifier string) string
	ClearEdgeJobTaskLogs(edgeJobID, taskID string) error
	GetEdgeJobTaskLogFileContent(edgeJobID, taskID string) (string, error)
	StoreEdgeJobTaskLogFileFromBytes(edgeJobID, taskID string, data []byte) error
	GetBinaryFolder() string
	StoreCustomTemplateFileFromBytes(identifier, fileName string, data []byte) (string, error)
	GetCustomTemplateProjectPath(identifier string) string
	GetTemporaryPath() (string, error)
	GetDatastorePath() string
	GetDefaultSSLCertsPath() (string, string)
	StoreSSLCertPair(cert, key []byte) (string, string, error)
	CopySSLCertPair(certPath, keyPath string) (string, string, error)
	CopySSLCACert(caCertPath string) (string, error)
	StoreFDOProfileFileFromBytes(fdoProfileIdentifier string, data []byte) (string, error)
	StoreMTLSCertificates(cert, caCert, key []byte) (string, string, string, error)
	GetDefaultChiselPrivateKeyPath() string
	StoreChiselPrivateKey(privateKey []byte) error
}

type GitService interface {
	CloneRepository(destination string, repositoryURL, referenceName, username, password string, tlsSkipVerify bool) error
	LatestCommitID(repositoryURL, referenceName, username, password string, tlsSkipVerify bool) (string, error)
	ListRefs(repositoryURL, username, password string, hardRefresh bool, tlsSkipVerify bool) ([]string, error)
	ListFiles(repositoryURL, referenceName, username, password string, dirOnly, hardRefresh bool, includeExts []string, tlsSkipVerify bool) ([]string, error)
}

type GitlabRegistryData struct {
	ProjectID   int    `json:"ProjectId"`
	InstanceURL string `json:"InstanceURL"`
	ProjectPath string `json:"ProjectPath"`
}

type HelmUserRepository struct {
	// Membership Identifier
	ID HelmUserRepositoryID `json:"Id" example:"1"`
	// User identifier
	UserID UserID `json:"UserId" example:"1"`
	// Helm repository URL
	URL string `json:"URL" example:"https://charts.bitnami.com/bitnami"`
}

type HelmUserRepositoryID int

type InternalAuthSettings struct {
	RequiredPasswordLength int
}

type JobType int

type K8sNamespaceAccessPolicy struct {
	UserAccessPolicies UserAccessPolicies `json:"UserAccessPolicies"`
	TeamAccessPolicies TeamAccessPolicies `json:"TeamAccessPolicies"`
}

type K8sNamespaceInfo struct {
	IsSystem  bool `json:"IsSystem"`
	IsDefault bool `json:"IsDefault"`
}

type K8sNodeLimits struct {
	CPU    int64 `json:"CPU"`
	Memory int64 `json:"Memory"`
}

type K8sNodesLimits map[string]*K8sNodeLimits

type KubeClient interface {
	SetupUserServiceAccount(userID int, teamIDs []int, restrictDefaultNamespace bool) error
	IsRBACEnabled() (bool, error)
	GetServiceAccount(tokendata *TokenData) (*v1.ServiceAccount, error)
	GetServiceAccountBearerToken(userID int) (string, error)
	CreateUserShellPod(ctx context.Context, serviceAccountName, shellPodImage string) (*KubernetesShellPod, error)
	StartExecProcess(token string, useAdminToken bool, namespace, podName, containerName string, command []string, stdin io.Reader, stdout io.Writer, errChan chan error)

	HasStackName(namespace string, stackName string) (bool, error)
	NamespaceAccessPoliciesDeleteNamespace(namespace string) error
	CreateNamespace(info models.K8sNamespaceDetails) error
	UpdateNamespace(info models.K8sNamespaceDetails) error
	GetNamespaces() (map[string]K8sNamespaceInfo, error)
	GetNamespace(string) (K8sNamespaceInfo, error)
	DeleteNamespace(namespace string) error
	GetConfigMapsAndSecrets(namespace string) ([]models.K8sConfigMapOrSecret, error)
	GetIngressControllers() (models.K8sIngressControllers, error)
	GetMetrics() (models.K8sMetrics, error)
	GetStorage() ([]KubernetesStorageClassConfig, error)
	CreateIngress(namespace string, info models.K8sIngressInfo, owner string) error
	UpdateIngress(namespace string, info models.K8sIngressInfo) error
	GetIngresses(namespace string) ([]models.K8sIngressInfo, error)
	DeleteIngresses(reqs models.K8sIngressDeleteRequests) error
	CreateService(namespace string, service models.K8sServiceInfo) error
	UpdateService(namespace string, service models.K8sServiceInfo) error
	GetServices(namespace string, lookupApplications bool) ([]models.K8sServiceInfo, error)
	DeleteServices(reqs models.K8sServiceDeleteRequests) error
	GetNodesLimits() (K8sNodesLimits, error)
	GetNamespaceAccessPolicies() (map[string]K8sNamespaceAccessPolicy, error)
	UpdateNamespaceAccessPolicies(accessPolicies map[string]K8sNamespaceAccessPolicy) error
	DeleteRegistrySecret(registry *Registry, namespace string) error
	CreateRegistrySecret(registry *Registry, namespace string) error
	IsRegistrySecret(namespace, secretName string) (bool, error)
	ToggleSystemState(namespace string, isSystem bool) error
}

type KubernetesConfiguration struct {
	UseLoadBalancer                 bool                           `json:"UseLoadBalancer"`
	UseServerMetrics                bool                           `json:"UseServerMetrics"`
	EnableResourceOverCommit        bool                           `json:"EnableResourceOverCommit"`
	ResourceOverCommitPercentage    int                            `json:"ResourceOverCommitPercentage"`
	StorageClasses                  []KubernetesStorageClassConfig `json:"StorageClasses"`
	IngressClasses                  []KubernetesIngressClassConfig `json:"IngressClasses"`
	RestrictDefaultNamespace        bool                           `json:"RestrictDefaultNamespace"`
	IngressAvailabilityPerNamespace bool                           `json:"IngressAvailabilityPerNamespace"`
	AllowNoneIngressClass           bool                           `json:"AllowNoneIngressClass"`
}

type KubernetesData struct {
	Snapshots     []KubernetesSnapshot    `json:"Snapshots"`
	Configuration KubernetesConfiguration `json:"Configuration"`
	Flags         KubernetesFlags         `json:"Flags"`
}

type KubernetesDeployer interface {
	Deploy(userID UserID, endpoint *Endpoint, manifestFiles []string, namespace string) (string, error)
	Remove(userID UserID, endpoint *Endpoint, manifestFiles []string, namespace string) (string, error)
	ConvertCompose(data []byte) ([]byte, error)
}

type KubernetesFlags struct {
	IsServerMetricsDetected      bool `json:"IsServerMetricsDetected"`
	IsServerIngressClassDetected bool `json:"IsServerIngressClassDetected"`
	IsServerStorageDetected      bool `json:"IsServerStorageDetected"`
}

type KubernetesIngressClassConfig struct {
	Name              string   `json:"Name"`
	Type              string   `json:"Type"`
	GloballyBlocked   bool     `json:"Blocked"`
	BlockedNamespaces []string `json:"BlockedNamespaces"`
}

type KubernetesShellPod struct {
	Namespace        string
	PodName          string
	ContainerName    string
	ShellExecCommand string
}

type KubernetesSnapshot struct {
	Time              int64  `json:"Time"`
	KubernetesVersion string `json:"KubernetesVersion"`
	NodeCount         int    `json:"NodeCount"`
	TotalCPU          int64  `json:"TotalCPU"`
	TotalMemory       int64  `json:"TotalMemory"`
}

type KubernetesSnapshotter interface {
	CreateSnapshot(endpoint *Endpoint) (*KubernetesSnapshot, error)
}

type KubernetesStorageClassConfig struct {
	Name                 string   `json:"Name"`
	AccessModes          []string `json:"AccessModes"`
	Provisioner          string   `json:"Provisioner"`
	AllowVolumeExpansion bool     `json:"AllowVolumeExpansion"`
}

type LDAPGroupSearchSettings struct {
	// The distinguished name of the element from which the LDAP server will search for groups
	GroupBaseDN string `json:"GroupBaseDN" example:"dc=ldap,dc=domain,dc=tld"`
	// The LDAP search filter used to select group elements, optional
	GroupFilter string `json:"GroupFilter" example:"(objectClass=account"`
	// LDAP attribute which denotes the group membership
	GroupAttribute string `json:"GroupAttribute" example:"member"`
}

type LDAPSearchSettings struct {
	// The distinguished name of the element from which the LDAP server will search for users
	BaseDN string `json:"BaseDN" example:"dc=ldap,dc=domain,dc=tld"`
	// Optional LDAP search filter used to select user elements
	Filter string `json:"Filter" example:"(objectClass=account)"`
	// LDAP attribute which denotes the username
	UserNameAttribute string `json:"UserNameAttribute" example:"uid"`
}

type LDAPService interface {
	AuthenticateUser(username, password string, settings *LDAPSettings) error
	TestConnectivity(settings *LDAPSettings) error
	GetUserGroups(username string, settings *LDAPSettings) ([]string, error)
	SearchGroups(settings *LDAPSettings) ([]LDAPUser, error)
	SearchUsers(settings *LDAPSettings) ([]string, error)
}

type LDAPSettings struct {
	// Enable this option if the server is configured for Anonymous access. When enabled, ReaderDN and Password will not be used
	AnonymousMode bool `json:"AnonymousMode" example:"true" validate:"validate_bool"`
	// Account that will be used to search for users
	ReaderDN string `json:"ReaderDN" example:"cn=readonly-account,dc=ldap,dc=domain,dc=tld" validate:"required_if=AnonymousMode false"`
	// Password of the account that will be used to search users
	Password string `json:"Password,omitempty" example:"readonly-password" validate:"required_if=AnonymousMode false"`
	// URL or IP address of the LDAP server
	URL       string           `json:"URL" example:"myldap.domain.tld:389" validate:"hostname_port"`
	TLSConfig TLSConfiguration `json:"TLSConfig"`
	// Whether LDAP connection should use StartTLS
	StartTLS            bool                      `json:"StartTLS" example:"true"`
	SearchSettings      []LDAPSearchSettings      `json:"SearchSettings"`
	GroupSearchSettings []LDAPGroupSearchSettings `json:"GroupSearchSettings"`
	// Automatically provision users and assign them to matching LDAP group names
	AutoCreateUsers bool `json:"AutoCreateUsers" example:"true"`
}

type LDAPUser struct {
	Name   string
	Groups []string
}

type LicenseInformation struct {
	LicenseKey string `json:"LicenseKey,omitempty"`
	Company    string `json:"Company,omitempty"`
	Expiration string `json:"Expiration,omitempty"`
	Valid      bool   `json:"Valid,omitempty"`
}

type MembershipRole int

type OAuthService interface {
	Authenticate(code string, configuration *OAuthSettings) (string, error)
}

type OAuthSettings struct {
	ClientID             string `json:"ClientID"`
	ClientSecret         string `json:"ClientSecret,omitempty"`
	AccessTokenURI       string `json:"AccessTokenURI"`
	AuthorizationURI     string `json:"AuthorizationURI"`
	ResourceURI          string `json:"ResourceURI"`
	RedirectURI          string `json:"RedirectURI"`
	UserIdentifier       string `json:"UserIdentifier"`
	Scopes               string `json:"Scopes"`
	OAuthAutoCreateUsers bool   `json:"OAuthAutoCreateUsers"`
	DefaultTeamID        TeamID `json:"DefaultTeamID"`
	SSO                  bool   `json:"SSO"`
	LogoutURI            string `json:"LogoutURI"`
	KubeSecretKey        []byte `json:"KubeSecretKey"`
}

type OpenAMTConfiguration struct {
	Enabled          bool   `json:"enabled"`
	MPSServer        string `json:"mpsServer"`
	MPSUser          string `json:"mpsUser"`
	MPSPassword      string `json:"mpsPassword"`
	MPSToken         string `json:"mpsToken"` // retrieved from API
	CertFileName     string `json:"certFileName"`
	CertFileContent  string `json:"certFileContent"`
	CertFilePassword string `json:"certFilePassword"`
	DomainName       string `json:"domainName"`
}

type OpenAMTDeviceEnabledFeatures struct {
	Redirection bool   `json:"redirection"`
	KVM         bool   `json:"KVM"`
	SOL         bool   `json:"SOL"`
	IDER        bool   `json:"IDER"`
	UserConsent string `json:"userConsent"`
}

type OpenAMTDeviceInformation struct {
	GUID             string                        `json:"guid"`
	HostName         string                        `json:"hostname"`
	ConnectionStatus bool                          `json:"connectionStatus"`
	PowerState       PowerState                    `json:"powerState"`
	EnabledFeatures  *OpenAMTDeviceEnabledFeatures `json:"features"`
}

type OpenAMTService interface {
	Configure(configuration OpenAMTConfiguration) error
	DeviceInformation(configuration OpenAMTConfiguration, deviceGUID string) (*OpenAMTDeviceInformation, error)
	EnableDeviceFeatures(configuration OpenAMTConfiguration, deviceGUID string, features OpenAMTDeviceEnabledFeatures) (string, error)
	ExecuteDeviceAction(configuration OpenAMTConfiguration, deviceGUID string, action string) error
}

type Pair struct {
	Name  string `json:"name" example:"name"`
	Value string `json:"value" example:"value"`
}

type PerDevConfigsFilterType string

type PowerState int

type QuayRegistryData struct {
	UseOrganisation  bool   `json:"UseOrganisation"`
	OrganisationName string `json:"OrganisationName"`
}

type ReadTransaction interface {
	GetObject(bucketName string, key []byte, object interface{}) error
	GetAll(bucketName string, obj interface{}, append func(o interface{}) (interface{}, error)) error
	GetAllWithJsoniter(bucketName string, obj interface{}, append func(o interface{}) (interface{}, error)) error
	GetAllWithKeyPrefix(bucketName string, keyPrefix []byte, obj interface{}, append func(o interface{}) (interface{}, error)) error
}

type Registry struct {
	// Registry Identifier
	ID RegistryID `json:"Id" example:"1"`
	// Registry Type (1 - Quay, 2 - Azure, 3 - Custom, 4 - Gitlab, 5 - ProGet, 6 - DockerHub, 7 - ECR)
	Type RegistryType `json:"Type" enums:"1,2,3,4,5,6,7"`
	// Registry Name
	Name string `json:"Name" example:"my-registry"`
	// URL or IP address of the Docker registry
	URL string `json:"URL" example:"registry.mydomain.tld:2375"`
	// Base URL, introduced for ProGet registry
	BaseURL string `json:"BaseURL" example:"registry.mydomain.tld:2375"`
	// Is authentication against this registry enabled
	Authentication bool `json:"Authentication" example:"true"`
	// Username or AccessKeyID used to authenticate against this registry
	Username string `json:"Username" example:"registry user"`
	// Password or SecretAccessKey used to authenticate against this registry
	Password                string                           `json:"Password,omitempty" example:"registry_password"`
	ManagementConfiguration *RegistryManagementConfiguration `json:"ManagementConfiguration"`
	Gitlab                  GitlabRegistryData               `json:"Gitlab"`
	Quay                    QuayRegistryData                 `json:"Quay"`
	Ecr                     EcrData                          `json:"Ecr"`
	RegistryAccesses        RegistryAccesses                 `json:"RegistryAccesses"`

	// Deprecated fields
	// Deprecated in DBVersion == 31
	UserAccessPolicies UserAccessPolicies `json:"UserAccessPolicies"`
	// Deprecated in DBVersion == 31
	TeamAccessPolicies TeamAccessPolicies `json:"TeamAccessPolicies"`

	// Deprecated in DBVersion == 18
	AuthorizedUsers []UserID `json:"AuthorizedUsers"`
	// Deprecated in DBVersion == 18
	AuthorizedTeams []TeamID `json:"AuthorizedTeams"`

	// Stores temporary access token
	AccessToken       string `json:"AccessToken,omitempty"`
	AccessTokenExpiry int64  `json:"AccessTokenExpiry,omitempty"`
}

type RegistryAccessPolicies struct {
	UserAccessPolicies UserAccessPolicies `json:"UserAccessPolicies"`
	TeamAccessPolicies TeamAccessPolicies `json:"TeamAccessPolicies"`
	Namespaces         []string           `json:"Namespaces"`
}

type RegistryAccesses map[EndpointID]RegistryAccessPolicies

type RegistryID int

type RegistryManagementConfiguration struct {
	Type              RegistryType     `json:"Type"`
	Authentication    bool             `json:"Authentication"`
	Username          string           `json:"Username"`
	Password          string           `json:"Password"`
	TLSConfig         TLSConfiguration `json:"TLSConfig"`
	Ecr               EcrData          `json:"Ecr"`
	AccessToken       string           `json:"AccessToken,omitempty"`
	AccessTokenExpiry int64            `json:"AccessTokenExpiry,omitempty"`
}

type RegistryType int

type ResourceAccessLevel int

type ResourceControl struct {
	// ResourceControl Identifier
	ID ResourceControlID `json:"Id" example:"1"`
	// Docker resource identifier on which access control will be applied.\
	// In the case of a resource control applied to a stack, use the stack name as identifier
	ResourceID string `json:"ResourceId" example:"617c5f22bb9b023d6daab7cba43a57576f83492867bc767d1c59416b065e5f08"`
	// List of Docker resources that will inherit this access control
	SubResourceIDs []string `json:"SubResourceIds" example:"617c5f22bb9b023d6daab7cba43a57576f83492867bc767d1c59416b065e5f08"`
	// Type of Docker resource. Valid values are: 1- container, 2 -service
	// 3 - volume, 4 - secret, 5 - stack, 6 - config or 7 - custom template
	Type         ResourceControlType  `json:"Type" example:"1"`
	UserAccesses []UserResourceAccess `json:"UserAccesses"`
	TeamAccesses []TeamResourceAccess `json:"TeamAccesses"`
	// Permit access to the associated resource to any user
	Public bool `json:"Public" example:"true"`
	// Permit access to resource only to admins
	AdministratorsOnly bool `json:"AdministratorsOnly" example:"true"`
	System             bool `json:"System"`

	// Deprecated fields
	// Deprecated in DBVersion == 2
	OwnerID     UserID              `json:"OwnerId,omitempty"`
	AccessLevel ResourceAccessLevel `json:"AccessLevel,omitempty"`
}

type ResourceControlID int

type ResourceControlType int

type ReverseTunnelService interface {
	StartTunnelServer(addr, port string, snapshotService SnapshotService) error
	StopTunnelServer() error
	GenerateEdgeKey(url, host string, endpointIdentifier int) string
	SetTunnelStatusToActive(endpointID EndpointID)
	SetTunnelStatusToRequired(endpointID EndpointID) error
	SetTunnelStatusToIdle(endpointID EndpointID)
	KeepTunnelAlive(endpointID EndpointID, ctx context.Context, maxKeepAlive time.Duration)
	GetTunnelDetails(endpointID EndpointID) TunnelDetails
	GetActiveTunnel(endpoint *Endpoint) (TunnelDetails, error)
	AddEdgeJob(endpoint *Endpoint, edgeJob *EdgeJob)
	RemoveEdgeJob(edgeJobID EdgeJobID)
	RemoveEdgeJobFromEndpoint(endpointID EndpointID, edgeJobID EdgeJobID)
}

type Role struct {
	// Role Identifier
	ID RoleID `json:"Id" example:"1"`
	// Role name
	Name string `json:"Name" example:"HelpDesk"`
	// Role description
	Description string `json:"Description" example:"Read-only access of all resources in an environment(endpoint)"`
	// Authorizations associated to a role
	Authorizations Authorizations `json:"Authorizations"`
	Priority       int            `json:"Priority"`
}

type RoleID int

type SSLSettings struct {
	CertPath    string `json:"certPath"`
	KeyPath     string `json:"keyPath"`
	SelfSigned  bool   `json:"selfSigned"`
	HTTPEnabled bool   `json:"httpEnabled"`
}

type Schedule struct {
	// Schedule Identifier
	ID             ScheduleID `json:"Id" example:"1"`
	Name           string
	CronExpression string
	Recurring      bool
	Created        int64
	JobType        JobType
	EdgeSchedule   *EdgeSchedule
}

type ScheduleID int

type ScriptExecutionJob struct {
	Endpoints     []EndpointID
	Image         string
	ScriptPath    string
	RetryCount    int
	RetryInterval int
}

type Server interface {
	Start() error
}

type Settings struct {
	// URL to a logo that will be displayed on the login page as well as on top of the sidebar. Will use default Portainer logo when value is empty string
	LogoURL string `json:"LogoURL" example:"https://mycompany.mydomain.tld/logo.png"`
	// A list of label name & value that will be used to hide containers when querying containers
	BlackListedLabels []Pair `json:"BlackListedLabels"`
	// Active authentication method for the Portainer instance. Valid values are: 1 for internal, 2 for LDAP, or 3 for oauth
	AuthenticationMethod AuthenticationMethod          `json:"AuthenticationMethod" example:"1"`
	InternalAuthSettings InternalAuthSettings          `json:"InternalAuthSettings"`
	LDAPSettings         LDAPSettings                  `json:"LDAPSettings"`
	OAuthSettings        OAuthSettings                 `json:"OAuthSettings"`
	OpenAMTConfiguration OpenAMTConfiguration          `json:"openAMTConfiguration"`
	FDOConfiguration     FDOConfiguration              `json:"fdoConfiguration"`
	FeatureFlagSettings  map[featureflags.Feature]bool `json:"FeatureFlagSettings"`
	// The interval in which environment(endpoint) snapshots are created
	SnapshotInterval string `json:"SnapshotInterval" example:"5m"`
	// URL to the templates that will be displayed in the UI when navigating to App Templates
	TemplatesURL string `json:"TemplatesURL" example:"https://raw.githubusercontent.com/portainer/templates/master/templates.json"`
	// The default check in interval for edge agent (in seconds)
	EdgeAgentCheckinInterval int `json:"EdgeAgentCheckinInterval" example:"5"`
	// Show the Kompose build option (discontinued in 2.18)
	ShowKomposeBuildOption bool `json:"ShowKomposeBuildOption" example:"false"`
	// Whether edge compute features are enabled
	EnableEdgeComputeFeatures bool `json:"EnableEdgeComputeFeatures"`
	// The duration of a user session
	UserSessionTimeout string `json:"UserSessionTimeout" example:"5m"`
	// The expiry of a Kubeconfig
	KubeconfigExpiry string `json:"KubeconfigExpiry" example:"24h"`
	// Whether telemetry is enabled
	EnableTelemetry bool `json:"EnableTelemetry" example:"false"`
	// Helm repository URL, defaults to "https://charts.bitnami.com/bitnami"
	HelmRepositoryURL string `json:"HelmRepositoryURL" example:"https://charts.bitnami.com/bitnami"`
	// KubectlImage, defaults to portainer/kubectl-shell
	KubectlShellImage string `json:"KubectlShellImage" example:"portainer/kubectl-shell"`
	// TrustOnFirstConnect makes Portainer accepting edge agent connection by default
	TrustOnFirstConnect bool `json:"TrustOnFirstConnect" example:"false"`
	// EnforceEdgeID makes Portainer store the Edge ID instead of accepting anyone
	EnforceEdgeID bool `json:"EnforceEdgeID" example:"false"`
	// Container environment parameter AGENT_SECRET
	AgentSecret string `json:"AgentSecret"`
	// EdgePortainerURL is the URL that is exposed to edge agents
	EdgePortainerURL string `json:"EdgePortainerUrl"`

	Edge struct {
		// The command list interval for edge agent - used in edge async mode (in seconds)
		CommandInterval int `json:"CommandInterval" example:"5"`
		// The ping interval for edge agent - used in edge async mode (in seconds)
		PingInterval int `json:"PingInterval" example:"5"`
		// The snapshot interval for edge agent - used in edge async mode (in seconds)
		SnapshotInterval int `json:"SnapshotInterval" example:"5"`

		// Deprecated 2.18
		AsyncMode bool
	}

	// Deprecated fields
	DisplayDonationHeader       bool
	DisplayExternalContributors bool

	// Deprecated fields v26
	EnableHostManagementFeatures              bool `json:"EnableHostManagementFeatures"`
	AllowVolumeBrowserForRegularUsers         bool `json:"AllowVolumeBrowserForRegularUsers"`
	AllowBindMountsForRegularUsers            bool `json:"AllowBindMountsForRegularUsers"`
	AllowPrivilegedModeForRegularUsers        bool `json:"AllowPrivilegedModeForRegularUsers"`
	AllowHostNamespaceForRegularUsers         bool `json:"AllowHostNamespaceForRegularUsers"`
	AllowStackManagementForRegularUsers       bool `json:"AllowStackManagementForRegularUsers"`
	AllowDeviceMappingForRegularUsers         bool `json:"AllowDeviceMappingForRegularUsers"`
	AllowContainerCapabilitiesForRegularUsers bool `json:"AllowContainerCapabilitiesForRegularUsers"`

	IsDockerDesktopExtension bool `json:"IsDockerDesktopExtension"`
}

type Snapshot struct {
	EndpointID EndpointID          `json:"EndpointId"`
	Docker     *DockerSnapshot     `json:"Docker"`
	Kubernetes *KubernetesSnapshot `json:"Kubernetes"`
}

type SnapshotJob struct{}

type SnapshotService interface {
	Start()
	SetSnapshotInterval(snapshotInterval string) error
	SnapshotEndpoint(endpoint *Endpoint) error
	FillSnapshotData(endpoint *Endpoint) error
}

type SoftwareEdition int

type Stack struct {
	// Stack Identifier
	ID StackID `json:"Id" example:"1"`
	// Stack name
	Name string `json:"Name" example:"myStack"`
	// Stack type. 1 for a Swarm stack, 2 for a Compose stack
	Type StackType `json:"Type" example:"2"`
	// Environment(Endpoint) identifier. Reference the environment(endpoint) that will be used for deployment
	EndpointID EndpointID `json:"EndpointId" example:"1"`
	// Cluster identifier of the Swarm cluster where the stack is deployed
	SwarmID string `json:"SwarmId" example:"jpofkc0i9uo9wtx1zesuk649w"`
	// Path to the Stack file
	EntryPoint string `json:"EntryPoint" example:"docker-compose.yml"`
	// A list of environment(endpoint) variables used during stack deployment
	Env []Pair `json:"Env"`
	//
	ResourceControl *ResourceControl `json:"ResourceControl"`
	// Stack status (1 - active, 2 - inactive)
	Status StackStatus `json:"Status" example:"1"`
	// Path on disk to the repository hosting the Stack file
	ProjectPath string `example:"/data/compose/myStack_jpofkc0i9uo9wtx1zesuk649w"`
	// The date in unix time when stack was created
	CreationDate int64 `example:"1587399600"`
	// The username which created this stack
	CreatedBy string `example:"admin"`
	// The date in unix time when stack was last updated
	UpdateDate int64 `example:"1587399600"`
	// The username which last updated this stack
	UpdatedBy string `example:"bob"`
	// Only applies when deploying stack with multiple files
	AdditionalFiles []string `json:"AdditionalFiles"`
	// The GitOps update settings of a git stack
	AutoUpdate *AutoUpdateSettings `json:"AutoUpdate"`
	// The stack deployment option
	Option *StackOption `json:"Option"`
	// The git config of this stack
	GitConfig *gittypes.RepoConfig
	// Whether the stack is from a app template
	FromAppTemplate bool `example:"false"`
	// Kubernetes namespace if stack is a kube application
	Namespace string `example:"default"`
	// IsComposeFormat indicates if the Kubernetes stack is created from a Docker Compose file
	IsComposeFormat bool `example:"false"`
}

type StackDeploymentInfo struct {
	// Version is the version of the stack and also is the deployed version in edge agent
	Version int `json:"Version"`
	// FileVersion is the version of the stack file, used to detect changes
	FileVersion int `json:"FileVersion"`
	// ConfigHash is the commit hash of the git repository used for deploying the stack
	ConfigHash string `json:"ConfigHash"`
}

type StackID int

type StackOption struct {
	// Prune services that are no longer referenced
	Prune bool `example:"false"`
}

type StackStatus int

type StackType int

type Status struct {
	// Portainer API version
	Version string `json:"Version" example:"2.0.0"`
	// Server Instance ID
	InstanceID string `example:"299ab403-70a8-4c05-92f7-bf7a994d50df"`
}

type SwarmStackManager interface {
	Login(registries []Registry, endpoint *Endpoint) error
	Logout(endpoint *Endpoint) error
	Deploy(stack *Stack, prune bool, pullImage bool, endpoint *Endpoint) error
	Remove(stack *Stack, endpoint *Endpoint) error
	NormalizeStackName(name string) string
}

type TLSConfiguration struct {
	// Use TLS
	TLS bool `json:"TLS" example:"true"`
	// Skip the verification of the server TLS certificate
	TLSSkipVerify bool `json:"TLSSkipVerify" example:"false"`
	// Path to the TLS CA certificate file
	TLSCACertPath string `json:"TLSCACert,omitempty" example:"/data/tls/ca.pem"`
	// Path to the TLS client certificate file
	TLSCertPath string `json:"TLSCert,omitempty" example:"/data/tls/cert.pem"`
	// Path to the TLS client key file
	TLSKeyPath string `json:"TLSKey,omitempty" example:"/data/tls/key.pem"`
}

type TLSFileType int

type Tag struct {
	// Tag identifier
	ID TagID `example:"1"`
	// Tag name
	Name string `json:"Name" example:"org/acme"`
	// A set of environment(endpoint) ids that have this tag
	Endpoints map[EndpointID]bool `json:"Endpoints"`
	// A set of environment(endpoint) group ids that have this tag
	EndpointGroups map[EndpointGroupID]bool `json:"EndpointGroups"`
}

type TagID int

type Team struct {
	// Team Identifier
	ID TeamID `json:"Id" example:"1"`
	// Team name
	Name string `json:"Name" example:"developers"`
}

type TeamAccessPolicies map[TeamID]AccessPolicy

type TeamID int

type TeamMembership struct {
	// Membership Identifier
	ID TeamMembershipID `json:"Id" example:"1"`
	// User identifier
	UserID UserID `json:"UserID" example:"1"`
	// Team identifier
	TeamID TeamID `json:"TeamID" example:"1"`
	// Team role (1 for team leader and 2 for team member)
	Role MembershipRole `json:"Role" example:"1"`
}

type TeamMembershipID int

type TeamResourceAccess struct {
	TeamID      TeamID              `json:"TeamId"`
	AccessLevel ResourceAccessLevel `json:"AccessLevel"`
}

type Template struct {
	// Mandatory container/stack fields
	// Template Identifier
	ID TemplateID `json:"Id" example:"1"`
	// Template type. Valid values are: 1 (container), 2 (Swarm stack), 3 (Compose stack), 4 (Compose edge stack)
	Type TemplateType `json:"type" example:"1"`
	// Title of the template
	Title string `json:"title" example:"Nginx"`
	// Description of the template
	Description string `json:"description" example:"High performance web server"`
	// Whether the template should be available to administrators only
	AdministratorOnly bool `json:"administrator_only" example:"true"`

	// Mandatory container fields
	// Image associated to a container template. Mandatory for a container template
	Image string `json:"image" example:"nginx:latest"`

	// Mandatory stack fields
	Repository TemplateRepository `json:"repository"`

	// Mandatory Edge stack fields
	// Stack file used for this template
	StackFile string `json:"stackFile"`

	// Optional stack/container fields
	// Default name for the stack/container to be used on deployment
	Name string `json:"name,omitempty" example:"mystackname"`
	// URL of the template's logo
	Logo string `json:"logo,omitempty" example:"https://portainer.io/img/logo.svg"`
	// A list of environment(endpoint) variables used during the template deployment
	Env []TemplateEnv `json:"env,omitempty"`
	// A note that will be displayed in the UI. Supports HTML content
	Note string `json:"note,omitempty" example:"This is my <b>custom</b> template"`
	// Platform associated to the template.
	// Valid values are: 'linux', 'windows' or leave empty for multi-platform
	Platform string `json:"platform,omitempty" example:"linux"`
	// A list of categories associated to the template
	Categories []string `json:"categories,omitempty" example:"database"`

	// Optional container fields
	// The URL of a registry associated to the image for a container template
	Registry string `json:"registry,omitempty" example:"quay.io"`
	// The command that will be executed in a container template
	Command string `json:"command,omitempty" example:"ls -lah"`
	// Name of a network that will be used on container deployment if it exists inside the environment(endpoint)
	Network string `json:"network,omitempty" example:"mynet"`
	// A list of volumes used during the container template deployment
	Volumes []TemplateVolume `json:"volumes,omitempty"`
	// A list of ports exposed by the container
	Ports []string `json:"ports,omitempty" example:"8080:80/tcp"`
	// Container labels
	Labels []Pair `json:"labels,omitempty"`
	// Whether the container should be started in privileged mode
	Privileged bool `json:"privileged,omitempty" example:"true"`
	// Whether the container should be started in
	// interactive mode (-i -t equivalent on the CLI)
	Interactive bool `json:"interactive,omitempty" example:"true"`
	// Container restart policy
	RestartPolicy string `json:"restart_policy,omitempty" example:"on-failure"`
	// Container hostname
	Hostname string `json:"hostname,omitempty" example:"mycontainer"`
}

type TemplateEnv struct {
	// name of the environment(endpoint) variable
	Name string `json:"name" example:"MYSQL_ROOT_PASSWORD"`
	// Text for the label that will be generated in the UI
	Label string `json:"label,omitempty" example:"Root password"`
	// Content of the tooltip that will be generated in the UI
	Description string `json:"description,omitempty" example:"MySQL root account password"`
	// Default value that will be set for the variable
	Default string `json:"default,omitempty" example:"default_value"`
	// If set to true, will not generate any input for this variable in the UI
	Preset bool `json:"preset,omitempty" example:"false"`
	// A list of name/value that will be used to generate a dropdown in the UI
	Select []TemplateEnvSelect `json:"select,omitempty"`
}

type TemplateEnvSelect struct {
	// Some text that will displayed as a choice
	Text string `json:"text" example:"text value"`
	// A value that will be associated to the choice
	Value string `json:"value" example:"value"`
	// Will set this choice as the default choice
	Default bool `json:"default" example:"false"`
}

type TemplateID int

type TemplateRepository struct {
	// URL of a git repository used to deploy a stack template. Mandatory for a Swarm/Compose stack template
	URL string `json:"url" example:"https://github.com/portainer/portainer-compose"`
	// Path to the stack file inside the git repository
	StackFile string `json:"stackfile" example:"./subfolder/docker-compose.yml"`
}

type TemplateType int

type TemplateVolume struct {
	// Path inside the container
	Container string `json:"container" example:"/data"`
	// Path on the host
	Bind string `json:"bind,omitempty" example:"/tmp"`
	// Whether the volume used should be readonly
	ReadOnly bool `json:"readonly,omitempty" example:"true"`
}

type TokenData struct {
	ID                  UserID
	Username            string
	Role                UserRole
	ForceChangePassword bool
}

type Transaction interface {
	ReadTransaction

	SetServiceName(bucketName string) error
	UpdateObject(bucketName string, key []byte, object interface{}) error
	DeleteObject(bucketName string, key []byte) error
	CreateObject(bucketName string, fn func(uint64) (int, interface{})) error
	CreateObjectWithId(bucketName string, id int, obj interface{}) error
	CreateObjectWithStringId(bucketName string, id []byte, obj interface{}) error
	DeleteAllObjects(bucketName string, obj interface{}, matching func(o interface{}) (id int, ok bool)) error
	GetNextIdentifier(bucketName string) int
}

type TunnelDetails struct {
	Status       string
	LastActivity time.Time
	Port         int
	Jobs         []EdgeJob
	Credentials  string
}

type TunnelServerInfo struct {
	PrivateKeySeed string `json:"PrivateKeySeed"`
}

type User struct {
	// User Identifier
	ID       UserID `json:"Id" example:"1"`
	Username string `json:"Username" example:"bob"`
	Password string `json:"Password,omitempty" swaggerignore:"true"`
	// User role (1 for administrator account and 2 for regular account)
	Role          UserRole `json:"Role" example:"1"`
	TokenIssueAt  int64    `json:"TokenIssueAt" example:"1"`
	ThemeSettings UserThemeSettings

	// Deprecated
	UserTheme string `example:"dark"`
	// Deprecated in DBVersion == 25
	PortainerAuthorizations Authorizations
	// Deprecated in DBVersion == 25
	EndpointAuthorizations EndpointAuthorizations
}

type UserAccessPolicies map[UserID]AccessPolicy

type UserID int

type UserResourceAccess struct {
	UserID      UserID              `json:"UserId"`
	AccessLevel ResourceAccessLevel `json:"AccessLevel"`
}

type UserRole int

type UserThemeSettings struct {
	// Color represents the color theme of the UI
	Color string `json:"color" example:"dark" enums:"dark,light,highcontrast,auto"`
}

type Webhook struct {
	// Webhook Identifier
	ID         WebhookID  `json:"Id" example:"1"`
	Token      string     `json:"Token"`
	ResourceID string     `json:"ResourceId"`
	EndpointID EndpointID `json:"EndpointId"`
	RegistryID RegistryID `json:"RegistryId"`
	// Type of webhook (1 - service)
	WebhookType WebhookType `json:"Type"`
}

type WebhookID int

type WebhookType int