api

Documentation

Index

• func GetSource(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func ListSources(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func PutSource(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• type ApiUserPublicEmailResponse
• type GithubConfig
• type GithubResponse
  • func GetSourceFromEnv() (*GithubResponse, error)
• type GithubSource
• type PublicEmail

Functions

func GetSource

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

GET /plugins/github/sources/:sourceId

func ListSources

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

GET /plugins/github/sources

func PutSource

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

PUT /plugins/github/sources/:sourceId

func TestConnection

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

GET /plugins/github/test

Types

type ApiUserPublicEmailResponse

type ApiUserPublicEmailResponse []PublicEmail

type GithubConfig

type GithubConfig struct {
	GITHUB_ENDPOINT string `mapstructure:"GITHUB_ENDPOINT"`
	GITHUB_AUTH     string `mapstructure:"GITHUB_AUTH"`
	GITHUB_PROXY    string `mapstructure:"GITHUB_PROXY"`
}

type GithubResponse

type GithubResponse struct {
	Endpoint string
	Auth     string
	Name     string
	ID       int
	Proxy    string `json:"proxy"`
}

This object conforms to what the frontend currently expects.

func GetSourceFromEnv

func GetSourceFromEnv() (*GithubResponse, error)

type GithubSource

type GithubSource struct {
	GITHUB_ENDPOINT string
	GITHUB_AUTH     string
	GITHUB_PROXY    string
}

This object conforms to what the frontend currently sends.

type PublicEmail

type PublicEmail struct {
	Email      string
	Primary    bool
	Verified   bool
	Visibility string
}

Using Public Email because it requires authentication, and it is public information anyway. We're not using email information for anything here.