Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BaseRegistry ¶
type BaseRegistry struct {
// Name of the registry.
//
// Required: true
Name string `json:"name"`
// Description of the registry.
//
// Required: true
Description string `json:"description"`
// URL of the registry.
//
// Required: true
URL string `json:"url"`
}
BaseRegistry contains common fields shared by all registry types.
type BaseTemplate ¶
type BaseTemplate struct {
// ID is the unique identifier of the template.
//
// Required: true
ID string `json:"id"`
// Name of the template.
//
// Required: true
Name string `json:"name"`
// Description of the template.
//
// Required: true
Description string `json:"description"`
}
BaseTemplate contains common fields shared by all template types.
type CreateRegistryRequest ¶
type CreateRegistryRequest struct {
// Name of the registry.
//
// Required: true
Name string `json:"name"`
// URL of the registry.
//
// Required: true
URL string `json:"url"`
// Description of the registry.
//
// Required: false
Description string `json:"description"`
// Enabled indicates if the registry is enabled.
//
// Required: false
Enabled bool `json:"enabled"`
}
CreateRegistryRequest represents the request to create a template registry.
type CreateRequest ¶
type CreateRequest struct {
// Name of the template.
//
// Required: true
Name string `json:"name"`
// Description of the template.
//
// Required: false
Description string `json:"description"`
// Content is the Docker Compose file content.
//
// Required: true
Content string `json:"content"`
// EnvContent is the environment file content.
//
// Required: false
EnvContent string `json:"envContent"`
}
CreateRequest represents the request to create a template.
type DefaultTemplatesResponse ¶
type DefaultTemplatesResponse struct {
// ComposeTemplate is the default Docker Compose template content.
//
// Required: true
ComposeTemplate string `json:"composeTemplate"`
// EnvTemplate is the default environment template content.
//
// Required: true
EnvTemplate string `json:"envTemplate"`
}
DefaultTemplatesResponse contains the default compose and env templates.
type RemoteRegistry ¶
type RemoteRegistry struct {
BaseRegistry
// Schema is the JSON schema reference for the registry.
//
// Required: false
Schema string `json:"$schema,omitempty"`
// Version of the registry.
//
// Required: true
Version string `json:"version"`
// Author of the registry.
//
// Required: true
Author string `json:"author"`
// Templates is a list of templates available in the registry.
//
// Required: true
Templates []RemoteTemplate `json:"templates"`
}
RemoteRegistry represents a remote template registry configuration.
type RemoteTemplate ¶
type RemoteTemplate struct {
BaseTemplate
// Version of the template.
//
// Required: true
Version string `json:"version"`
// Author of the template.
//
// Required: true
Author string `json:"author"`
// ComposeURL is the URL to the Docker Compose file.
//
// Required: true
ComposeURL string `json:"compose_url"`
// EnvURL is the URL to the environment file.
//
// Required: true
EnvURL string `json:"env_url"`
// DocumentationURL is the URL to the template documentation.
//
// Required: true
DocumentationURL string `json:"documentation_url"`
// Tags is a list of tags associated with the template.
//
// Required: true
Tags []string `json:"tags"`
}
RemoteTemplate represents a template from a remote registry.
type SaveDefaultTemplatesRequest ¶
type SaveDefaultTemplatesRequest struct {
// ComposeContent is the Docker Compose template content.
//
// Required: true
ComposeContent string `json:"composeContent"`
// EnvContent is the environment template content.
//
// Required: false
EnvContent string `json:"envContent"`
}
SaveDefaultTemplatesRequest represents the request to save default templates.
type Template ¶
type Template struct {
BaseTemplate
// Content is the Docker Compose file content.
//
// Required: true
Content string `json:"content"`
// EnvContent is the environment file content.
//
// Required: false
EnvContent *string `json:"envContent,omitempty"`
// IsCustom indicates if this is a user-created custom template.
//
// Required: true
IsCustom bool `json:"isCustom"`
// IsRemote indicates if this template is from a remote registry.
//
// Required: true
IsRemote bool `json:"isRemote"`
// RegistryID is the ID of the registry this template belongs to.
//
// Required: false
RegistryID *string `json:"registryId,omitempty"`
// Registry is the registry information if the template is from a registry.
//
// Required: false
Registry *TemplateRegistry `json:"registry,omitempty"`
// Metadata contains additional metadata about the template.
//
// Required: false
Metadata *meta.TemplateMeta `json:"metadata,omitempty"`
}
Template represents a Docker Compose template.
type TemplateContent ¶
type TemplateContent struct {
// Template is the template information.
//
// Required: true
Template Template `json:"template"`
// Content is the Docker Compose file content.
//
// Required: true
Content string `json:"content"`
// EnvContent is the environment file content.
//
// Required: true
EnvContent string `json:"envContent"`
// Services is a list of service names defined in the template.
//
// Required: true
Services []string `json:"services"`
// EnvVariables is a list of environment variables used in the template.
//
// Required: true
EnvVariables []env.Variable `json:"envVariables"`
}
TemplateContent contains a template with its associated content and metadata.
type TemplateRegistry ¶
type TemplateRegistry struct {
BaseRegistry
// ID is the unique identifier of the registry.
//
// Required: true
ID string `json:"id"`
// Enabled indicates if the registry is enabled.
//
// Required: true
Enabled bool `json:"enabled"`
}
Registry represents a local registry configuration.
type UpdateRegistryRequest ¶
type UpdateRegistryRequest struct {
// Name of the registry.
//
// Required: true
Name string `json:"name"`
// URL of the registry.
//
// Required: true
URL string `json:"url"`
// Description of the registry.
//
// Required: false
Description string `json:"description"`
// Enabled indicates if the registry is enabled.
//
// Required: false
Enabled bool `json:"enabled"`
}
UpdateRegistryRequest represents the request to update a template registry.
type UpdateRequest ¶
type UpdateRequest struct {
// Name of the template.
//
// Required: true
Name string `json:"name"`
// Description of the template.
//
// Required: false
Description string `json:"description"`
// Content is the Docker Compose file content.
//
// Required: true
Content string `json:"content"`
// EnvContent is the environment file content.
//
// Required: false
EnvContent string `json:"envContent"`
}
UpdateRequest represents the request to update a template.