github

Documentation

Index

• Constants
• func Mount(instances []plugin.Instance, clustersClient clusters.Client) (chi.Router, error)
• type OAuthResponse
• type Router

Constants

const PluginType = "github"

PluginType is the type which must be used for the GitHub plugin.

Functions

func Mount

func Mount(instances []plugin.Instance, clustersClient clusters.Client) (chi.Router, error)

Mount mounts the GitHub plugin routes in the plugins router of a kobs satellite instance.

Types

type OAuthResponse

type OAuthResponse struct {
	Organization string `json:"organization"`
	Token        string `json:"token"`
	Username     string `json:"username"`
}

OAuthResponse is the response data returned when the a user finished the oauth process or when the user is authenticated in the oauth call.

type Router

type Router struct {
	*chi.Mux
	// contains filtered or unexported fields
}

Router implements the router for the GitHub plugin, which can be registered in the router for our rest api. It contains the api routes for the GitHub plugin and it's configuration.