Documentation
¶
Index ¶
- type APIController
- func (a *APIController) CatchAll(w http.ResponseWriter, r *http.Request)
- func (a *APIController) CreateEnterpriseHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) CreateEnterprisePoolHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) CreateOrgHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) CreateOrgPoolHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) CreateRepoHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) CreateRepoPoolHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) DeleteEnterpriseHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) DeleteEnterprisePoolHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) DeleteInstanceHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) DeleteOrgHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) DeleteOrgPoolHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) DeletePoolByIDHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) DeleteRepoHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) DeleteRepoPoolHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) FirstRunHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) GetEnterpriseByIDHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) GetEnterprisePoolHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) GetInstanceHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) GetOrgByIDHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) GetOrgPoolHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) GetPoolByIDHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) GetRepoByIDHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) GetRepoPoolHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) InstanceGithubRegistrationTokenHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) InstanceStatusMessageHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListAllInstancesHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListAllJobs(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListAllPoolsHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListCredentials(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListEnterpriseInstancesHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListEnterprisePoolsHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListEnterprisesHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListOrgInstancesHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListOrgPoolsHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListOrgsHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListPoolInstancesHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListProviders(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListRepoInstancesHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListRepoPoolsHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) ListReposHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) LoginHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) MetricsTokenHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) NotFoundHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) UpdateEnterpriseHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) UpdateEnterprisePoolHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) UpdateOrgHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) UpdateOrgPoolHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) UpdatePoolByIDHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) UpdateRepoHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) UpdateRepoPoolHandler(w http.ResponseWriter, r *http.Request)
- func (a *APIController) WSHandler(writer http.ResponseWriter, req *http.Request)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIController ¶
type APIController struct {
// contains filtered or unexported fields
}
func NewAPIController ¶
func NewAPIController(r *runner.Runner, authenticator *auth.Authenticator, hub *wsWriter.Hub) (*APIController, error)
func (*APIController) CatchAll ¶
func (a *APIController) CatchAll(w http.ResponseWriter, r *http.Request)
func (*APIController) CreateEnterpriseHandler ¶
func (a *APIController) CreateEnterpriseHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) CreateEnterprisePoolHandler ¶
func (a *APIController) CreateEnterprisePoolHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) CreateOrgHandler ¶
func (a *APIController) CreateOrgHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) CreateOrgPoolHandler ¶
func (a *APIController) CreateOrgPoolHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) CreateRepoHandler ¶
func (a *APIController) CreateRepoHandler(w http.ResponseWriter, r *http.Request)
swagger:route POST /repositories repositories CreateRepo
Create repository with the parameters given.
Parameters:
+ name: Body
description: Parameters used when creating the repository.
type: CreateRepoParams
in: body
required: true
Responses:
200: Repository
default: APIErrorResponse
func (*APIController) CreateRepoPoolHandler ¶
func (a *APIController) CreateRepoPoolHandler(w http.ResponseWriter, r *http.Request)
swagger:route POST /repositories/{repoID}/pools repositories pools CreateRepoPool
Create repository pool with the parameters given.
Parameters:
+ name: repoID
description: Repository ID.
type: string
in: path
required: true
+ name: Body
description: Parameters used when creating the repository pool.
type: CreatePoolParams
in: body
required: true
Responses:
200: Pool
default: APIErrorResponse
func (*APIController) DeleteEnterpriseHandler ¶
func (a *APIController) DeleteEnterpriseHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) DeleteEnterprisePoolHandler ¶
func (a *APIController) DeleteEnterprisePoolHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) DeleteInstanceHandler ¶
func (a *APIController) DeleteInstanceHandler(w http.ResponseWriter, r *http.Request)
swagger:route DELETE /instances/{instanceName} instances DeleteInstance
Delete runner instance by name.
Parameters:
+ name: instanceName
description: Runner instance name.
type: string
in: path
required: true
Responses:
default: APIErrorResponse
func (*APIController) DeleteOrgHandler ¶
func (a *APIController) DeleteOrgHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) DeleteOrgPoolHandler ¶
func (a *APIController) DeleteOrgPoolHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) DeletePoolByIDHandler ¶
func (a *APIController) DeletePoolByIDHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) DeleteRepoHandler ¶
func (a *APIController) DeleteRepoHandler(w http.ResponseWriter, r *http.Request)
swagger:route DELETE /repositories/{repoID} repositories DeleteRepo
Delete repository by ID.
Parameters:
+ name: repoID
description: ID of the repository to delete.
type: string
in: path
required: true
Responses:
default: APIErrorResponse
func (*APIController) DeleteRepoPoolHandler ¶
func (a *APIController) DeleteRepoPoolHandler(w http.ResponseWriter, r *http.Request)
swagger:route DELETE /repositories/{repoID}/pools/{poolID} repositories pools DeleteRepoPool
Delete repository pool by ID.
Parameters:
+ name: repoID
description: Repository ID.
type: string
in: path
required: true
+ name: poolID
description: ID of the repository pool to delete.
type: string
in: path
required: true
Responses:
default: APIErrorResponse
func (*APIController) FirstRunHandler ¶
func (a *APIController) FirstRunHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) GetEnterpriseByIDHandler ¶
func (a *APIController) GetEnterpriseByIDHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) GetEnterprisePoolHandler ¶
func (a *APIController) GetEnterprisePoolHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) GetInstanceHandler ¶
func (a *APIController) GetInstanceHandler(w http.ResponseWriter, r *http.Request)
swagger:route GET /instances/{instanceName} instances GetInstance
Get runner instance by name.
Parameters:
+ name: instanceName
description: Runner instance name.
type: string
in: path
required: true
Responses:
200: Instance
default: APIErrorResponse
func (*APIController) GetOrgByIDHandler ¶
func (a *APIController) GetOrgByIDHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) GetOrgPoolHandler ¶
func (a *APIController) GetOrgPoolHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) GetPoolByIDHandler ¶
func (a *APIController) GetPoolByIDHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) GetRepoByIDHandler ¶
func (a *APIController) GetRepoByIDHandler(w http.ResponseWriter, r *http.Request)
swagger:route GET /repositories/{repoID} repositories GetRepo
Get repository by ID.
Parameters:
+ name: repoID
description: ID of the repository to fetch.
type: string
in: path
required: true
Responses:
200: Repository
default: APIErrorResponse
func (*APIController) GetRepoPoolHandler ¶
func (a *APIController) GetRepoPoolHandler(w http.ResponseWriter, r *http.Request)
swagger:route GET /repositories/{repoID}/pools/{poolID} repositories pools GetRepoPool
Get repository pool by ID.
Parameters:
+ name: repoID
description: Repository ID.
type: string
in: path
required: true
+ name: poolID
description: Pool ID.
type: string
in: path
required: true
Responses:
200: Pool
default: APIErrorResponse
func (*APIController) InstanceGithubRegistrationTokenHandler ¶
func (a *APIController) InstanceGithubRegistrationTokenHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) InstanceStatusMessageHandler ¶
func (a *APIController) InstanceStatusMessageHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) ListAllInstancesHandler ¶
func (a *APIController) ListAllInstancesHandler(w http.ResponseWriter, r *http.Request)
swagger:route GET /instances instances ListInstances
Get all runners' instances.
Responses: 200: Instances default: APIErrorResponse
func (*APIController) ListAllJobs ¶ added in v0.1.2
func (a *APIController) ListAllJobs(w http.ResponseWriter, r *http.Request)
func (*APIController) ListAllPoolsHandler ¶
func (a *APIController) ListAllPoolsHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) ListCredentials ¶
func (a *APIController) ListCredentials(w http.ResponseWriter, r *http.Request)
func (*APIController) ListEnterpriseInstancesHandler ¶
func (a *APIController) ListEnterpriseInstancesHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) ListEnterprisePoolsHandler ¶
func (a *APIController) ListEnterprisePoolsHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) ListEnterprisesHandler ¶
func (a *APIController) ListEnterprisesHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) ListOrgInstancesHandler ¶
func (a *APIController) ListOrgInstancesHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) ListOrgPoolsHandler ¶
func (a *APIController) ListOrgPoolsHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) ListOrgsHandler ¶
func (a *APIController) ListOrgsHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) ListPoolInstancesHandler ¶
func (a *APIController) ListPoolInstancesHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) ListProviders ¶
func (a *APIController) ListProviders(w http.ResponseWriter, r *http.Request)
func (*APIController) ListRepoInstancesHandler ¶
func (a *APIController) ListRepoInstancesHandler(w http.ResponseWriter, r *http.Request)
swagger:route GET /repositories/{repoID}/instances repositories instances ListRepoInstances
List repository instances.
Parameters:
+ name: repoID
description: Repository ID.
type: string
in: path
required: true
Responses:
200: Instances
default: APIErrorResponse
func (*APIController) ListRepoPoolsHandler ¶
func (a *APIController) ListRepoPoolsHandler(w http.ResponseWriter, r *http.Request)
swagger:route GET /repositories/{repoID}/pools repositories pools ListRepoPools
List repository pools.
Parameters:
+ name: repoID
description: Repository ID.
type: string
in: path
required: true
Responses:
200: Pools
default: APIErrorResponse
func (*APIController) ListReposHandler ¶
func (a *APIController) ListReposHandler(w http.ResponseWriter, r *http.Request)
swagger:route GET /repositories repositories ListRepos
List repositories.
Responses: 200: Repositories default: APIErrorResponse
func (*APIController) LoginHandler ¶
func (a *APIController) LoginHandler(w http.ResponseWriter, r *http.Request)
LoginHandler returns a jwt token
func (*APIController) MetricsTokenHandler ¶
func (a *APIController) MetricsTokenHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) NotFoundHandler ¶
func (a *APIController) NotFoundHandler(w http.ResponseWriter, r *http.Request)
NotFoundHandler is returned when an invalid URL is acccessed
func (*APIController) UpdateEnterpriseHandler ¶
func (a *APIController) UpdateEnterpriseHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) UpdateEnterprisePoolHandler ¶
func (a *APIController) UpdateEnterprisePoolHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) UpdateOrgHandler ¶
func (a *APIController) UpdateOrgHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) UpdateOrgPoolHandler ¶
func (a *APIController) UpdateOrgPoolHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) UpdatePoolByIDHandler ¶
func (a *APIController) UpdatePoolByIDHandler(w http.ResponseWriter, r *http.Request)
func (*APIController) UpdateRepoHandler ¶
func (a *APIController) UpdateRepoHandler(w http.ResponseWriter, r *http.Request)
swagger:route PUT /repositories/{repoID} repositories UpdateRepo
Update repository with the parameters given.
Parameters:
+ name: repoID
description: ID of the repository to update.
type: string
in: path
required: true
+ name: Body
description: Parameters used when updating the repository.
type: UpdateEntityParams
in: body
required: true
Responses:
200: Repository
default: APIErrorResponse
func (*APIController) UpdateRepoPoolHandler ¶
func (a *APIController) UpdateRepoPoolHandler(w http.ResponseWriter, r *http.Request)
swagger:route PUT /repositories/{repoID}/pools/{poolID} repositories pools UpdateRepoPool
Update repository pool with the parameters given.
Parameters:
+ name: repoID
description: Repository ID.
type: string
in: path
required: true
+ name: poolID
description: ID of the repository pool to update.
type: string
in: path
required: true
+ name: Body
description: Parameters used when updating the repository pool.
type: UpdatePoolParams
in: body
required: true
Responses:
200: Pool
default: APIErrorResponse
func (*APIController) WSHandler ¶
func (a *APIController) WSHandler(writer http.ResponseWriter, req *http.Request)