Docker/portainer
Docker/portainer
1
0
Fork 0
mirror of https://github.com/portainer/portainer.git synced 2025-08-09 15:55:23 +02:00
Code Issues Releases Activity

fix(swagger/doc): align fields in endpoint update payload and response

Browse source
This commit is contained in:
oscarzhou 2023-05-01 17:28:48 +12:00
parent 731f3959c7
commit 2fb745c3f8
1 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

26
api/http/handler/endpoints/endpoint_update.go
View file

@ -16,24 +16,24 @@ import (
type endpointUpdatePayload struct { type endpointUpdatePayload struct {
// Name that will be used to identify this environment(endpoint) // Name that will be used to identify this environment(endpoint)
Name *string `example:"my-environment"` Name *string `json:"Name" example:"my-environment"`
// URL or IP address of a Docker host // URL or IP address of a Docker host
URL *string `example:"docker.mydomain.tld:2375"` URL *string `json:"URL" example:"docker.mydomain.tld:2375"`
// URL or IP address where exposed containers will be reachable.\ // URL or IP address where exposed containers will be reachable.\
// Defaults to URL if not specified // Defaults to URL if not specified
PublicURL *string `example:"docker.mydomain.tld:2375"` PublicURL *string `json:"PublicURL" example:"docker.mydomain.tld:2375"`
// GPUs information // GPUs information
Gpus []portainer.Pair Gpus []portainer.Pair `json:"Gpus"`
// Group identifier // Group identifier
GroupID *int `example:"1"` GroupID *int `json:"GroupId" example:"1"`
// Require TLS to connect against this environment(endpoint) // Require TLS to connect against this environment(endpoint)
TLS *bool `example:"true"` TLS *bool `json:"TLS" example:"true"`
// Skip server verification when using TLS // Skip server verification when using TLS
TLSSkipVerify *bool `example:"false"` TLSSkipVerify *bool `json:"TLSSkipVerify" example:"false"`
// Skip client verification when using TLS // Skip client verification when using TLS
TLSSkipClientVerify *bool `example:"false"` TLSSkipClientVerify *bool `example:"false"`
// The status of the environment(endpoint) (1 - up, 2 - down) // The status of the environment(endpoint) (1 - up, 2 - down)
Status *int `example:"1"` Status *int `json:"Status" example:"1"`
// Azure application ID // Azure application ID
AzureApplicationID *string `example:"eag7cdo9-o09l-9i83-9dO9-f0b23oe78db4"` AzureApplicationID *string `example:"eag7cdo9-o09l-9i83-9dO9-f0b23oe78db4"`
// Azure tenant ID // Azure tenant ID
@ -41,13 +41,13 @@ type endpointUpdatePayload struct {
// Azure authentication key // Azure authentication key
AzureAuthenticationKey *string `example:"cOrXoK/1D35w8YQ8nH1/8ZGwzz45JIYD5jxHKXEQknk="` AzureAuthenticationKey *string `example:"cOrXoK/1D35w8YQ8nH1/8ZGwzz45JIYD5jxHKXEQknk="`
// List of tag identifiers to which this environment(endpoint) is associated // List of tag identifiers to which this environment(endpoint) is associated
TagIDs []portainer.TagID `example:"1,2"` TagIDs []portainer.TagID `json:"TagIds" example:"1,2"`
UserAccessPolicies portainer.UserAccessPolicies UserAccessPolicies portainer.UserAccessPolicies `json:"UserAccessPolicies"`
TeamAccessPolicies portainer.TeamAccessPolicies TeamAccessPolicies portainer.TeamAccessPolicies `json:"TeamAccessPolicies"`
// The check in interval for edge agent (in seconds) // The check in interval for edge agent (in seconds)
EdgeCheckinInterval *int `example:"5"` EdgeCheckinInterval *int `json:"EdgeCheckinInterval" example:"5"`
// Associated Kubernetes data // Associated Kubernetes data
Kubernetes *portainer.KubernetesData Kubernetes *portainer.KubernetesData `json:"Kubernetes"`
} }
func (payload *endpointUpdatePayload) Validate(r *http.Request) error { func (payload *endpointUpdatePayload) Validate(r *http.Request) error {