github
/
portainer
mirror of https://github.com/portainer/portainer
1
0
Fork 0
Code Issues Releases Wiki Activity

docs(custom-templates): add missing parameters [EE-5233] (#8865)

pull/8901/head
Chaim Lev-Ari 2023-05-04 21:31:06 +07:00 committed by GitHub
parent 426c132f97
commit 2383d243d5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
api/http/handler/customtemplates/customtemplate_create.go
View File

@ -92,7 +92,10 @@ type customTemplateFromFileContentPayload struct {
// Valid values are: 1 - 'linux', 2 - 'windows' // Valid values are: 1 - 'linux', 2 - 'windows'
// Required for Docker stacks // Required for Docker stacks
Platform portainer.CustomTemplatePlatform `example:"1" enums:"1,2"` Platform portainer.CustomTemplatePlatform `example:"1" enums:"1,2"`
// Type of created stack (1 - swarm, 2 - compose, 3 - kubernetes) // Type of created stack:
// * 1 - swarm
// * 2 - compose
// * 3 - kubernetes
Type portainer.StackType `example:"1" enums:"1,2,3" validate:"required"` Type portainer.StackType `example:"1" enums:"1,2,3" validate:"required"`
// Content of stack file // Content of stack file
FileContent string `validate:"required"` FileContent string `validate:"required"`
@ -189,7 +192,10 @@ type customTemplateFromGitRepositoryPayload struct {
// Valid values are: 1 - 'linux', 2 - 'windows' // Valid values are: 1 - 'linux', 2 - 'windows'
// Required for Docker stacks // Required for Docker stacks
Platform portainer.CustomTemplatePlatform `example:"1" enums:"1,2"` Platform portainer.CustomTemplatePlatform `example:"1" enums:"1,2"`
// Type of created stack (1 - swarm, 2 - compose) // Type of created stack:
// * 1 - swarm
// * 2 - compose
// * 3 - kubernetes
Type portainer.StackType `example:"1" enums:"1,2" validate:"required"` Type portainer.StackType `example:"1" enums:"1,2" validate:"required"`
// URL of a Git repository hosting the Stack file // URL of a Git repository hosting the Stack file
@ -350,6 +356,10 @@ type customTemplateFromFileUploadPayload struct {
Description string Description string
Note string Note string
Platform portainer.CustomTemplatePlatform Platform portainer.CustomTemplatePlatform
// Type of created stack:
// * 1 - swarm
// * 2 - compose
// * 3 - kubernetes
Type portainer.StackType Type portainer.StackType
FileContent []byte FileContent []byte
// Definitions of variables in the stack file // Definitions of variables in the stack file
@ -420,12 +430,14 @@ func (payload *customTemplateFromFileUploadPayload) Validate(r *http.Request) er
// @security jwt // @security jwt
// @accept multipart/form-data // @accept multipart/form-data
// @produce json // @produce json
// @param Title formData string false "Title of the template" // @param Title formData string true "Title of the template"
// @param Description formData string false "Description of the template" // @param Description formData string true "Description of the template"
// @param Note formData string false "A note that will be displayed in the UI. Supports HTML content" // @param Note formData string true "A note that will be displayed in the UI. Supports HTML content"
// @param Platform formData int false "Platform associated to the template (1 - 'linux', 2 - 'windows')" Enums(1,2) // @param Platform formData int true "Platform associated to the template (1 - 'linux', 2 - 'windows')" Enums(1,2)
// @param Type formData int false "Type of created stack (1 - swarm, 2 - compose)" Enums(1,2) // @param Type formData int true "Type of created stack (1 - swarm, 2 - compose, 3 - kubernetes)" Enums(1,2,3)
// @param file formData file false "File" // @param File formData file true "File"
// @param Logo formData string false "URL of the template's logo" example:"https://cloudinovasi.id/assets/img/logos/nginx.png"
// @param Variables formData string false "A json array of variables definitions" example:"[{\"label\":\"image\",\"description\":\"Image name\",\"defaultValue\":\"nginx:latest\",\"name\":\"image\"}]"
// @success 200 {object} portainer.CustomTemplate // @success 200 {object} portainer.CustomTemplate
// @failure 400 "Invalid request" // @failure 400 "Invalid request"
// @failure 500 "Server error" // @failure 500 "Server error"

7
api/portainer.go
View File

@ -177,8 +177,11 @@ type (
Platform CustomTemplatePlatform `json:"Platform" example:"1" enums:"1,2"` Platform CustomTemplatePlatform `json:"Platform" example:"1" enums:"1,2"`
// URL of the template's logo // URL of the template's logo
Logo string `json:"Logo" example:"https://cloudinovasi.id/assets/img/logos/nginx.png"` Logo string `json:"Logo" example:"https://cloudinovasi.id/assets/img/logos/nginx.png"`
// Type of created stack (1 - swarm, 2 - compose) // Type of created stack:
Type StackType `json:"Type" example:"1"` // * 1 - swarm
// * 2 - compose
// * 3 - kubernetes
Type StackType `json:"Type" example:"1" enums:"1,2,3"`
ResourceControl *ResourceControl `json:"ResourceControl"` ResourceControl *ResourceControl `json:"ResourceControl"`
Variables []CustomTemplateVariableDefinition Variables []CustomTemplateVariableDefinition
GitConfig *gittypes.RepoConfig `json:"GitConfig"` GitConfig *gittypes.RepoConfig `json:"GitConfig"`