api

Documentation

Index

• func GetConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func ListConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func PostConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func PutConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• type JenkinsConnection
• type JenkinsResponse
  • func GetConnectionFromEnv() (*JenkinsResponse, error)
• type TestConnectionRequest

Functions

func GetConnection

func GetConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

GET /plugins/jenkins/connections/:connectionId

func ListConnections

func ListConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

GET /plugins/jenkins/connections

func PostConnection

func PostConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

POST /plugins/jenkins/connections

{
	"Endpoint": "your-endpoint",
	"Username": "your-username",
	"Password": "your-password",
}

func PutConnection

func PutConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

PUT /plugins/jenkins/connections/:connectionId

{
	"Endpoint": "your-endpoint",
	"Username": "your-username",
	"Password": "your-password",
}

func TestConnection

func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

Types

type JenkinsConnection

type JenkinsConnection struct {
	Endpoint string `mapstructure:"JENKINS_ENDPOINT" validate:"required"`
	Username string `mapstructure:"JENKINS_USERNAME" validate:"required"`
	Password string `mapstructure:"JENKINS_PASSWORD" validate:"required"`
	Proxy    string `mapstructure:"JENKINS_PROXY"`
}

This object conforms to what the frontend currently sends.

type JenkinsResponse

type JenkinsResponse struct {
	ID   int
	Name string
	JenkinsConnection
}

func GetConnectionFromEnv

func GetConnectionFromEnv() (*JenkinsResponse, error)

type TestConnectionRequest

type TestConnectionRequest struct {
	Endpoint string `json:"endpoint" validate:"required"`
	Username string `json:"username" validate:"required"`
	Password string `json:"password" validate:"required"`
	Proxy    string `json:"proxy"`
}