applications

Documentation

Index

• type AddProjectRequest
• type CreateBranchRequest
• type CreateRequest
• type CreateResponse
• type DeleteBranchRequest
• type DeleteRequest
• type RemoveProjectRequest
• type SetTagsRequest
• type ShowRequest
• type ShowResponse
• type UpdateBranchRequest
• type UpdateRequest

Types

type AddProjectRequest

type AddProjectRequest struct {
	Application string `form:"application"` // Key of the application
	Project     string `form:"project"`     // Key of the project
}

AddProjectRequest Add a project to an application.<br/>Requires 'Administrator' permission on the application

type CreateBranchRequest

type CreateBranchRequest struct {
	Application   string `form:"application"`   // Application key
	Branch        string `form:"branch"`        // Branch name
	Project       string `form:"project"`       // Project keys. To set several values, the parameter must be called once for each value.
	ProjectBranch string `form:"projectBranch"` // Project branches. To set main branch, provide an empty value. To set several values, the parameter must be called once for each value.
}

CreateBranchRequest Create a new branch on a given application.<br/>Requires 'Administrator' permission on the application and 'Browse' permission on its child projects

type CreateRequest

type CreateRequest struct {
	Description string `form:"description,omitempty"` // Application description
	Key         string `form:"key,omitempty"`         // Application key. A suitable key will be generated if not provided
	Name        string `form:"name"`                  // Application name
	Visibility  string `form:"visibility,omitempty"`  // Whether the created application should be visible to everyone, or only specific user/groups.<br/>If no visibility is specified, the default visibility will be used.
}

CreateRequest Create a new application.<br/>Requires 'Administer System' permission or 'Create Applications' permission

type CreateResponse

type CreateResponse struct {
	Application struct {
		Description string   `json:"description,omitempty"`
		Key         string   `json:"key,omitempty"`
		Name        string   `json:"name,omitempty"`
		Projects    []string `json:"projects,omitempty"`
		Visibility  string   `json:"visibility,omitempty"`
	} `json:"application,omitempty"`
}

CreateResponse is the response for CreateRequest

type DeleteBranchRequest

type DeleteBranchRequest struct {
	Application string `form:"application"` // Application key
	Branch      string `form:"branch"`      // Branch name
}

DeleteBranchRequest Delete a branch on a given application.<br/>Requires 'Administrator' permission on the application

type DeleteRequest

type DeleteRequest struct {
	Application string `form:"application"` // Application key
}

DeleteRequest Delete an application definition.<br/>Requires 'Administrator' permission on the application

type RemoveProjectRequest

type RemoveProjectRequest struct {
	Application string `form:"application"` // Key of the application
	Project     string `form:"project"`     // Key of the project
}

RemoveProjectRequest Remove a project from an application<br/>Requires 'Administrator' permission on the application

type SetTagsRequest

type SetTagsRequest struct {
	Application string `form:"application"` // Application key
	Tags        string `form:"tags"`        // Comma-separated list of tags
}

SetTagsRequest Set tags on a application.<br>Requires the following permission: 'Administer' rights on the specified application

type ShowRequest

type ShowRequest struct {
	Application string `url:"application"`      // Application key
	Branch      string `url:"branch,omitempty"` // Branch name
}

ShowRequest Returns an application and its associated projects. <br> Requires the 'Browse' permission on the application and on its child projects.

type ShowResponse

type ShowResponse struct {
	Application struct {
		Branch   string `json:"branch,omitempty"`
		Branches []struct {
			IsMain bool   `json:"isMain,omitempty"`
			Name   string `json:"name,omitempty"`
		} `json:"branches,omitempty"`
		IsMain   bool   `json:"isMain,omitempty"`
		Key      string `json:"key,omitempty"`
		Name     string `json:"name,omitempty"`
		Projects []struct {
			Branch   string `json:"branch,omitempty"`
			Enabled  bool   `json:"enabled,omitempty"`
			IsMain   bool   `json:"isMain,omitempty"`
			Key      string `json:"key,omitempty"`
			Name     string `json:"name,omitempty"`
			Selected bool   `json:"selected,omitempty"`
		} `json:"projects,omitempty"`
		Tags       []string `json:"tags,omitempty"`
		Visibility string   `json:"visibility,omitempty"`
	} `json:"application,omitempty"`
}

ShowResponse is the response for ShowRequest

type UpdateBranchRequest

type UpdateBranchRequest struct {
	Application   string `form:"application"`   // Application key
	Branch        string `form:"branch"`        // Branch name
	Name          string `form:"name"`          // New branch name
	Project       string `form:"project"`       // Project keys. To set several values, the parameter must be called once for each value.
	ProjectBranch string `form:"projectBranch"` // Project branches. To set main branch, provide an empty value. To set several values, the parameter must be called once for each value.
}

UpdateBranchRequest Update a branch on a given application.<br/>Requires 'Administrator' permission on the application and 'Browse' permission on its child projects

type UpdateRequest

type UpdateRequest struct {
	Application string `form:"application"`           // Application key
	Description string `form:"description,omitempty"` // New description for the application
	Name        string `form:"name"`                  // New name for the application
}

UpdateRequest Update an application.<br/>Requires 'Administrator' permission on the application