api

Documentation

Index

• func GetSource(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func ListSources(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func PostSource(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func PutSource(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• type JenkinsResponse
  • func GetSourceFromEnv() (*JenkinsResponse, error)
• type JenkinsSource
• type TestConnectionRequest

Functions

func GetSource

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

GET /plugins/jenkins/sources/:sourceId

func ListSources

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

GET /plugins/jenkins/sources

func PostSource

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

POST /plugins/jenkins/sources

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

func PutSource

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

PUT /plugins/jenkins/sources/:sourceId

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

func TestConnection

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

Types

type JenkinsResponse

type JenkinsResponse struct {
	ID   int
	Name string
	JenkinsSource
}

func GetSourceFromEnv

func GetSourceFromEnv() (*JenkinsResponse, error)

type JenkinsSource

type JenkinsSource 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 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"`
}