mirror of https://github.com/portainer/portainer
parent
eccc8131dd
commit
bb48ab00cb
|
@ -44,7 +44,7 @@ type (
|
||||||
// Status of the schedule (0 - pending, 1 - failed, 2 - success)
|
// Status of the schedule (0 - pending, 1 - failed, 2 - success)
|
||||||
Status UpdateScheduleStatusType `json:"status" example:"1" enums:"1,2,3"`
|
Status UpdateScheduleStatusType `json:"status" example:"1" enums:"1,2,3"`
|
||||||
// Error message if status is failed
|
// Error message if status is failed
|
||||||
Error string `json:"error" example:""`
|
Error string `json:"error" example:"error message"`
|
||||||
// Target version of the edge agent
|
// Target version of the edge agent
|
||||||
TargetVersion string `json:"targetVersion" example:"1"`
|
TargetVersion string `json:"targetVersion" example:"1"`
|
||||||
// Current version of the edge agent
|
// Current version of the edge agent
|
||||||
|
|
|
@ -26,7 +26,7 @@ func (payload *activeSchedulePayload) Validate(r *http.Request) error {
|
||||||
// @accept json
|
// @accept json
|
||||||
// @param body body activeSchedulePayload true "Active schedule query"
|
// @param body body activeSchedulePayload true "Active schedule query"
|
||||||
// @produce json
|
// @produce json
|
||||||
// @success 200 {array} edgetypes.EdgeUpdateSchedule
|
// @success 200 {array} edgetypes.EndpointUpdateScheduleRelation
|
||||||
// @failure 500
|
// @failure 500
|
||||||
// @router /edge_update_schedules/active [get]
|
// @router /edge_update_schedules/active [get]
|
||||||
func (handler *Handler) activeSchedules(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
func (handler *Handler) activeSchedules(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
||||||
|
|
|
@ -22,10 +22,10 @@ type settingsUpdatePayload struct {
|
||||||
// A list of label name & value that will be used to hide containers when querying containers
|
// A list of label name & value that will be used to hide containers when querying containers
|
||||||
BlackListedLabels []portainer.Pair
|
BlackListedLabels []portainer.Pair
|
||||||
// Active authentication method for the Portainer instance. Valid values are: 1 for internal, 2 for LDAP, or 3 for oauth
|
// Active authentication method for the Portainer instance. Valid values are: 1 for internal, 2 for LDAP, or 3 for oauth
|
||||||
AuthenticationMethod *int `example:"1"`
|
AuthenticationMethod *int `example:"1"`
|
||||||
InternalAuthSettings *portainer.InternalAuthSettings `example:""`
|
InternalAuthSettings *portainer.InternalAuthSettings
|
||||||
LDAPSettings *portainer.LDAPSettings `example:""`
|
LDAPSettings *portainer.LDAPSettings
|
||||||
OAuthSettings *portainer.OAuthSettings `example:""`
|
OAuthSettings *portainer.OAuthSettings
|
||||||
// The interval in which environment(endpoint) snapshots are created
|
// The interval in which environment(endpoint) snapshots are created
|
||||||
SnapshotInterval *string `example:"5m"`
|
SnapshotInterval *string `example:"5m"`
|
||||||
// URL to the templates that will be displayed in the UI when navigating to App Templates
|
// URL to the templates that will be displayed in the UI when navigating to App Templates
|
||||||
|
|
|
@ -24,7 +24,7 @@ type composeStackFromFileContentPayload struct {
|
||||||
// Content of the Stack file
|
// Content of the Stack file
|
||||||
StackFileContent string `example:"version: 3\n services:\n web:\n image:nginx" validate:"required"`
|
StackFileContent string `example:"version: 3\n services:\n web:\n image:nginx" validate:"required"`
|
||||||
// A list of environment(endpoint) variables used during stack deployment
|
// A list of environment(endpoint) variables used during stack deployment
|
||||||
Env []portainer.Pair `example:""`
|
Env []portainer.Pair
|
||||||
// Whether the stack is from a app template
|
// Whether the stack is from a app template
|
||||||
FromAppTemplate bool `example:"false"`
|
FromAppTemplate bool `example:"false"`
|
||||||
}
|
}
|
||||||
|
|
|
@ -318,25 +318,25 @@ type (
|
||||||
PublicURL string `json:"PublicURL" example:"docker.mydomain.tld:2375"`
|
PublicURL string `json:"PublicURL" example:"docker.mydomain.tld:2375"`
|
||||||
Gpus []Pair `json:"Gpus"`
|
Gpus []Pair `json:"Gpus"`
|
||||||
TLSConfig TLSConfiguration `json:"TLSConfig"`
|
TLSConfig TLSConfiguration `json:"TLSConfig"`
|
||||||
AzureCredentials AzureCredentials `json:"AzureCredentials,omitempty" example:""`
|
AzureCredentials AzureCredentials `json:"AzureCredentials,omitempty"`
|
||||||
// List of tag identifiers to which this environment(endpoint) is associated
|
// List of tag identifiers to which this environment(endpoint) is associated
|
||||||
TagIDs []TagID `json:"TagIds"`
|
TagIDs []TagID `json:"TagIds"`
|
||||||
// The status of the environment(endpoint) (1 - up, 2 - down)
|
// The status of the environment(endpoint) (1 - up, 2 - down)
|
||||||
Status EndpointStatus `json:"Status" example:"1"`
|
Status EndpointStatus `json:"Status" example:"1"`
|
||||||
// List of snapshots
|
// List of snapshots
|
||||||
Snapshots []DockerSnapshot `json:"Snapshots" example:""`
|
Snapshots []DockerSnapshot `json:"Snapshots"`
|
||||||
// List of user identifiers authorized to connect to this environment(endpoint)
|
// List of user identifiers authorized to connect to this environment(endpoint)
|
||||||
UserAccessPolicies UserAccessPolicies `json:"UserAccessPolicies"`
|
UserAccessPolicies UserAccessPolicies `json:"UserAccessPolicies"`
|
||||||
// List of team identifiers authorized to connect to this environment(endpoint)
|
// List of team identifiers authorized to connect to this environment(endpoint)
|
||||||
TeamAccessPolicies TeamAccessPolicies `json:"TeamAccessPolicies" example:""`
|
TeamAccessPolicies TeamAccessPolicies `json:"TeamAccessPolicies"`
|
||||||
// The identifier of the edge agent associated with this environment(endpoint)
|
// The identifier of the edge agent associated with this environment(endpoint)
|
||||||
EdgeID string `json:"EdgeID,omitempty" example:""`
|
EdgeID string `json:"EdgeID,omitempty"`
|
||||||
// The key which is used to map the agent to Portainer
|
// The key which is used to map the agent to Portainer
|
||||||
EdgeKey string `json:"EdgeKey" example:""`
|
EdgeKey string `json:"EdgeKey"`
|
||||||
// The check in interval for edge agent (in seconds)
|
// The check in interval for edge agent (in seconds)
|
||||||
EdgeCheckinInterval int `json:"EdgeCheckinInterval" example:"5"`
|
EdgeCheckinInterval int `json:"EdgeCheckinInterval" example:"5"`
|
||||||
// Associated Kubernetes data
|
// Associated Kubernetes data
|
||||||
Kubernetes KubernetesData `json:"Kubernetes" example:""`
|
Kubernetes KubernetesData `json:"Kubernetes"`
|
||||||
// Maximum version of docker-compose
|
// Maximum version of docker-compose
|
||||||
ComposeSyntaxMaxVersion string `json:"ComposeSyntaxMaxVersion" example:"3.8"`
|
ComposeSyntaxMaxVersion string `json:"ComposeSyntaxMaxVersion" example:"3.8"`
|
||||||
// Environment(Endpoint) specific security settings
|
// Environment(Endpoint) specific security settings
|
||||||
|
@ -396,8 +396,8 @@ type (
|
||||||
Name string `json:"Name" example:"my-environment-group"`
|
Name string `json:"Name" example:"my-environment-group"`
|
||||||
// Description associated to the environment(endpoint) group
|
// Description associated to the environment(endpoint) group
|
||||||
Description string `json:"Description" example:"Environment(Endpoint) group description"`
|
Description string `json:"Description" example:"Environment(Endpoint) group description"`
|
||||||
UserAccessPolicies UserAccessPolicies `json:"UserAccessPolicies" example:""`
|
UserAccessPolicies UserAccessPolicies `json:"UserAccessPolicies"`
|
||||||
TeamAccessPolicies TeamAccessPolicies `json:"TeamAccessPolicies" example:""`
|
TeamAccessPolicies TeamAccessPolicies `json:"TeamAccessPolicies"`
|
||||||
// List of tags associated to this environment(endpoint) group
|
// List of tags associated to this environment(endpoint) group
|
||||||
TagIDs []TagID `json:"TagIds"`
|
TagIDs []TagID `json:"TagIds"`
|
||||||
|
|
||||||
|
@ -757,13 +757,13 @@ type (
|
||||||
// Type of Docker resource. Valid values are: 1- container, 2 -service
|
// Type of Docker resource. Valid values are: 1- container, 2 -service
|
||||||
// 3 - volume, 4 - secret, 5 - stack, 6 - config or 7 - custom template
|
// 3 - volume, 4 - secret, 5 - stack, 6 - config or 7 - custom template
|
||||||
Type ResourceControlType `json:"Type" example:"1"`
|
Type ResourceControlType `json:"Type" example:"1"`
|
||||||
UserAccesses []UserResourceAccess `json:"UserAccesses" example:""`
|
UserAccesses []UserResourceAccess `json:"UserAccesses"`
|
||||||
TeamAccesses []TeamResourceAccess `json:"TeamAccesses" example:""`
|
TeamAccesses []TeamResourceAccess `json:"TeamAccesses"`
|
||||||
// Permit access to the associated resource to any user
|
// Permit access to the associated resource to any user
|
||||||
Public bool `json:"Public" example:"true"`
|
Public bool `json:"Public" example:"true"`
|
||||||
// Permit access to resource only to admins
|
// Permit access to resource only to admins
|
||||||
AdministratorsOnly bool `json:"AdministratorsOnly" example:"true"`
|
AdministratorsOnly bool `json:"AdministratorsOnly" example:"true"`
|
||||||
System bool `json:"System" example:""`
|
System bool `json:"System"`
|
||||||
|
|
||||||
// Deprecated fields
|
// Deprecated fields
|
||||||
// Deprecated in DBVersion == 2
|
// Deprecated in DBVersion == 2
|
||||||
|
@ -845,12 +845,12 @@ type (
|
||||||
BlackListedLabels []Pair `json:"BlackListedLabels"`
|
BlackListedLabels []Pair `json:"BlackListedLabels"`
|
||||||
// Active authentication method for the Portainer instance. Valid values are: 1 for internal, 2 for LDAP, or 3 for oauth
|
// 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"`
|
AuthenticationMethod AuthenticationMethod `json:"AuthenticationMethod" example:"1"`
|
||||||
InternalAuthSettings InternalAuthSettings `json:"InternalAuthSettings" example:""`
|
InternalAuthSettings InternalAuthSettings `json:"InternalAuthSettings"`
|
||||||
LDAPSettings LDAPSettings `json:"LDAPSettings" example:""`
|
LDAPSettings LDAPSettings `json:"LDAPSettings"`
|
||||||
OAuthSettings OAuthSettings `json:"OAuthSettings" example:""`
|
OAuthSettings OAuthSettings `json:"OAuthSettings"`
|
||||||
OpenAMTConfiguration OpenAMTConfiguration `json:"openAMTConfiguration" example:""`
|
OpenAMTConfiguration OpenAMTConfiguration `json:"openAMTConfiguration"`
|
||||||
FDOConfiguration FDOConfiguration `json:"fdoConfiguration" example:""`
|
FDOConfiguration FDOConfiguration `json:"fdoConfiguration"`
|
||||||
FeatureFlagSettings map[Feature]bool `json:"FeatureFlagSettings" example:""`
|
FeatureFlagSettings map[Feature]bool `json:"FeatureFlagSettings"`
|
||||||
// The interval in which environment(endpoint) snapshots are created
|
// The interval in which environment(endpoint) snapshots are created
|
||||||
SnapshotInterval string `json:"SnapshotInterval" example:"5m"`
|
SnapshotInterval string `json:"SnapshotInterval" example:"5m"`
|
||||||
// URL to the templates that will be displayed in the UI when navigating to App Templates
|
// URL to the templates that will be displayed in the UI when navigating to App Templates
|
||||||
|
@ -858,7 +858,7 @@ type (
|
||||||
// The default check in interval for edge agent (in seconds)
|
// The default check in interval for edge agent (in seconds)
|
||||||
EdgeAgentCheckinInterval int `json:"EdgeAgentCheckinInterval" example:"5"`
|
EdgeAgentCheckinInterval int `json:"EdgeAgentCheckinInterval" example:"5"`
|
||||||
// Whether edge compute features are enabled
|
// Whether edge compute features are enabled
|
||||||
EnableEdgeComputeFeatures bool `json:"EnableEdgeComputeFeatures" example:""`
|
EnableEdgeComputeFeatures bool `json:"EnableEdgeComputeFeatures"`
|
||||||
// The duration of a user session
|
// The duration of a user session
|
||||||
UserSessionTimeout string `json:"UserSessionTimeout" example:"5m"`
|
UserSessionTimeout string `json:"UserSessionTimeout" example:"5m"`
|
||||||
// The expiry of a Kubeconfig
|
// The expiry of a Kubeconfig
|
||||||
|
@ -933,9 +933,9 @@ type (
|
||||||
// Path to the Stack file
|
// Path to the Stack file
|
||||||
EntryPoint string `json:"EntryPoint" example:"docker-compose.yml"`
|
EntryPoint string `json:"EntryPoint" example:"docker-compose.yml"`
|
||||||
// A list of environment(endpoint) variables used during stack deployment
|
// A list of environment(endpoint) variables used during stack deployment
|
||||||
Env []Pair `json:"Env" example:""`
|
Env []Pair `json:"Env"`
|
||||||
//
|
//
|
||||||
ResourceControl *ResourceControl `json:"ResourceControl" example:""`
|
ResourceControl *ResourceControl `json:"ResourceControl"`
|
||||||
// Stack status (1 - active, 2 - inactive)
|
// Stack status (1 - active, 2 - inactive)
|
||||||
Status StackStatus `json:"Status" example:"1"`
|
Status StackStatus `json:"Status" example:"1"`
|
||||||
// Path on disk to the repository hosting the Stack file
|
// Path on disk to the repository hosting the Stack file
|
||||||
|
@ -1100,7 +1100,7 @@ type (
|
||||||
// A list of ports exposed by the container
|
// A list of ports exposed by the container
|
||||||
Ports []string `json:"ports,omitempty" example:"8080:80/tcp"`
|
Ports []string `json:"ports,omitempty" example:"8080:80/tcp"`
|
||||||
// Container labels
|
// Container labels
|
||||||
Labels []Pair `json:"labels,omitempty" example:""`
|
Labels []Pair `json:"labels,omitempty"`
|
||||||
// Whether the container should be started in privileged mode
|
// Whether the container should be started in privileged mode
|
||||||
Privileged bool `json:"privileged,omitempty" example:"true"`
|
Privileged bool `json:"privileged,omitempty" example:"true"`
|
||||||
// Whether the container should be started in
|
// Whether the container should be started in
|
||||||
|
|
Loading…
Reference in New Issue