api

Documentation

Index

• func WithInstanceConfig(ctx context.Context, config *conf.Configuration, instanceID string) (context.Context, error)
• type API
  • func NewAPI(globalConfig *conf.GlobalConfiguration, db storage.Connection) *API
  • func NewAPIFromConfigFile(filename string, version string) (*API, error)
  • func NewAPIWithVersion(ctx context.Context, globalConfig *conf.GlobalConfiguration, ...) *API
  • func (a *API) CreateInstance(w http.ResponseWriter, r *http.Request) error
  • func (a *API) DeleteInstance(w http.ResponseWriter, r *http.Request) error
  • func (a *API) GetAppManifest(w http.ResponseWriter, r *http.Request) error
  • func (a *API) GetInstance(w http.ResponseWriter, r *http.Request) error
  • func (a *API) HealthCheck(w http.ResponseWriter, r *http.Request) error
  • func (a *API) ListenAndServe(hostAndPort string)
  • func (a *API) Settings(w http.ResponseWriter, r *http.Request) error
  • func (a *API) UpdateInstance(w http.ResponseWriter, r *http.Request) error
• type BitBucketGateway
  • func NewBitBucketGateway() *BitBucketGateway
  • func (bb *BitBucketGateway) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type BitBucketTransport
  • func (t *BitBucketTransport) RoundTrip(r *http.Request) (*http.Response, error)
• type GatewayClaims
• type GitHubGateway
  • func NewGitHubGateway() *GitHubGateway
  • func (gh *GitHubGateway) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type GitHubTransport
  • func (t *GitHubTransport) RoundTrip(r *http.Request) (*http.Response, error)
• type GitLabGateway
  • func NewGitLabGateway() *GitLabGateway
  • func (gl *GitLabGateway) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type GitLabTransport
  • func (t *GitLabTransport) RoundTrip(r *http.Request) (*http.Response, error)
• type HTTPError
  • func (e *HTTPError) Cause() error
  • func (e *HTTPError) Error() string
  • func (e *HTTPError) WithInternalError(err error) *HTTPError
  • func (e *HTTPError) WithInternalMessage(fmtString string, args ...interface{}) *HTTPError
• type InstanceRequestParams
• type InstanceResponse
• type NetlifyMicroserviceClaims
• type OAuthError
  • func (e *OAuthError) Cause() error
  • func (e *OAuthError) Error() string
  • func (e *OAuthError) WithInternalError(err error) *OAuthError
  • func (e *OAuthError) WithInternalMessage(fmtString string, args ...interface{}) *OAuthError
• type Role
• type Settings

Functions

func WithInstanceConfig

func WithInstanceConfig(ctx context.Context, config *conf.Configuration, instanceID string) (context.Context, error)

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API is the main REST API

func NewAPI

func NewAPI(globalConfig *conf.GlobalConfiguration, db storage.Connection) *API

NewAPI instantiates a new REST API

func NewAPIFromConfigFile

func NewAPIFromConfigFile(filename string, version string) (*API, error)

NewAPIFromConfigFile creates a new REST API using the provided configuration file.

func NewAPIWithVersion

func NewAPIWithVersion(ctx context.Context, globalConfig *conf.GlobalConfiguration, db storage.Connection, version string) *API

NewAPIWithVersion creates a new REST API using the specified version

func (*API) CreateInstance

func (a *API) CreateInstance(w http.ResponseWriter, r *http.Request) error

func (*API) DeleteInstance

func (a *API) DeleteInstance(w http.ResponseWriter, r *http.Request) error

func (*API) GetAppManifest

func (a *API) GetAppManifest(w http.ResponseWriter, r *http.Request) error

func (*API) GetInstance

func (a *API) GetInstance(w http.ResponseWriter, r *http.Request) error

func (*API) HealthCheck

func (a *API) HealthCheck(w http.ResponseWriter, r *http.Request) error

func (*API) ListenAndServe

func (a *API) ListenAndServe(hostAndPort string)

ListenAndServe starts the REST API

func (*API) Settings

func (a *API) Settings(w http.ResponseWriter, r *http.Request) error

func (*API) UpdateInstance

func (a *API) UpdateInstance(w http.ResponseWriter, r *http.Request) error

type BitBucketGateway

type BitBucketGateway struct {
	// contains filtered or unexported fields
}

func NewBitBucketGateway

func NewBitBucketGateway() *BitBucketGateway

func (*BitBucketGateway) ServeHTTP

func (bb *BitBucketGateway) ServeHTTP(w http.ResponseWriter, r *http.Request)

type BitBucketTransport

type BitBucketTransport struct{}

func (*BitBucketTransport) RoundTrip

func (t *BitBucketTransport) RoundTrip(r *http.Request) (*http.Response, error)

type GatewayClaims

type GatewayClaims struct {
	jwt.StandardClaims
	Email        string                 `json:"email"`
	AppMetaData  map[string]interface{} `json:"app_metadata"`
	UserMetaData map[string]interface{} `json:"user_metadata"`
}

type GitHubGateway

type GitHubGateway struct {
	// contains filtered or unexported fields
}

GitHubGateway acts as a proxy to GitHub

func NewGitHubGateway

func NewGitHubGateway() *GitHubGateway

func (*GitHubGateway) ServeHTTP

func (gh *GitHubGateway) ServeHTTP(w http.ResponseWriter, r *http.Request)

type GitHubTransport

type GitHubTransport struct{}

func (*GitHubTransport) RoundTrip

func (t *GitHubTransport) RoundTrip(r *http.Request) (*http.Response, error)

type GitLabGateway

type GitLabGateway struct {
	// contains filtered or unexported fields
}

GitLabGateway acts as a proxy to Gitlab

func NewGitLabGateway

func NewGitLabGateway() *GitLabGateway

func (*GitLabGateway) ServeHTTP

func (gl *GitLabGateway) ServeHTTP(w http.ResponseWriter, r *http.Request)

type GitLabTransport

type GitLabTransport struct{}

func (*GitLabTransport) RoundTrip

func (t *GitLabTransport) RoundTrip(r *http.Request) (*http.Response, error)

type HTTPError

type HTTPError struct {
	Code            int    `json:"code"`
	Message         string `json:"msg"`
	InternalError   error  `json:"-"`
	InternalMessage string `json:"-"`
	ErrorID         string `json:"error_id,omitempty"`
}

HTTPError is an error with a message and an HTTP status code.

func (*HTTPError) Cause

func (e *HTTPError) Cause() error

Cause returns the root cause error

func (*HTTPError) Error

func (e *HTTPError) Error() string

func (*HTTPError) WithInternalError

func (e *HTTPError) WithInternalError(err error) *HTTPError

WithInternalError adds internal error information to the error

func (*HTTPError) WithInternalMessage

func (e *HTTPError) WithInternalMessage(fmtString string, args ...interface{}) *HTTPError

WithInternalMessage adds internal message information to the error

type InstanceRequestParams

type InstanceRequestParams struct {
	UUID       string              `json:"uuid"`
	BaseConfig *conf.Configuration `json:"config"`
}

type InstanceResponse

type InstanceResponse struct {
	models.Instance
	Endpoint string `json:"endpoint"`
	State    string `json:"state"`
}

type NetlifyMicroserviceClaims

type NetlifyMicroserviceClaims struct {
	SiteURL    string `json:"site_url"`
	InstanceID string `json:"id"`
	NetlifyID  string `json:"netlify_id"`
	jwt.StandardClaims
}

type OAuthError

type OAuthError struct {
	Err             string `json:"error"`
	Description     string `json:"description,omitempty"`
	InternalError   error  `json:"-"`
	InternalMessage string `json:"-"`
}

OAuthError is the JSON handler for OAuth2 error responses

func (*OAuthError) Cause

func (e *OAuthError) Cause() error

Cause returns the root cause error

func (*OAuthError) Error

func (e *OAuthError) Error() string

func (*OAuthError) WithInternalError

func (e *OAuthError) WithInternalError(err error) *OAuthError

WithInternalError adds internal error information to the error

func (*OAuthError) WithInternalMessage

func (e *OAuthError) WithInternalMessage(fmtString string, args ...interface{}) *OAuthError

WithInternalMessage adds internal message information to the error

type Role

type Role struct {
	Name string
}

type Settings

type Settings struct {
	GitHub    bool     `json:"github_enabled"`
	GitLab    bool     `json:"gitlab_enabled"`
	BitBucket bool     `json:"bitbucket_enabled"`
	Roles     []string `json:"roles"`
}