api

Documentation

Overview

SPDX-Copyright: Copyright (c) Capital One Services, LLC SPDX-License-Identifier: Apache-2.0 Copyright 2017 Capital One Services, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-Copyright: Copyright (c) Capital One Services, LLC SPDX-License-Identifier: Apache-2.0 Copyright 2017 Capital One Services, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-Copyright: Copyright (c) Capital One Services, LLC SPDX-License-Identifier: Apache-2.0 Copyright 2017 Capital One Services, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-Copyright: Copyright (c) Brad Rydzewski, project contributors, Capital One Services, LLC SPDX-License-Identifier: Apache-2.0 Copyright 2017 Brad Rydzewski, project contributors, Capital One Services, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-Copyright: Copyright (c) Capital One Services, LLC SPDX-License-Identifier: Apache-2.0 Copyright 2017 Capital One Services, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-Copyright: Copyright (c) Brad Rydzewski, project contributors, Capital One Services, LLC SPDX-License-Identifier: Apache-2.0 Copyright 2017 Brad Rydzewski, project contributors, Capital One Services, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-Copyright: Copyright (c) Capital One Services, LLC SPDX-License-Identifier: Apache-2.0 Copyright 2017 Capital One Services, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-Copyright: Copyright (c) Capital One Services, LLC SPDX-License-Identifier: Apache-2.0 Copyright 2017 Capital One Services, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-Copyright: Copyright (c) Brad Rydzewski, project contributors, Capital One Services, LLC SPDX-License-Identifier: Apache-2.0 Copyright 2017 Brad Rydzewski, project contributors, Capital One Services, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-Copyright: Copyright (c) Capital One Services, LLC SPDX-License-Identifier: Apache-2.0 Copyright 2017 Capital One Services, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func AdminDeleteOrg(c *gin.Context)
• func AdminDeleteRepo(c *gin.Context)
• func AdminStats(c *gin.Context)
• func CheckAdmin(c *gin.Context)
• func Convert(c *gin.Context)
• func DeleteOrg(c *gin.Context)
• func DeleteRepo(c *gin.Context)
• func DeleteSlackUrl(c *gin.Context)
• func DeleteUser(c *gin.Context)
• func GetAllConfigurationSubtree(c *gin.Context)
• func GetAllRepos(c *gin.Context)
• func GetAllReposCount(c *gin.Context)
• func GetConfig(c *gin.Context)
• func GetEnabledOrgs(c *gin.Context)
• func GetMaintainer(c *gin.Context)
• func GetOrgRepos(c *gin.Context)
• func GetOrgs(c *gin.Context)
• func GetRepo(c *gin.Context)
• func GetReposForUserLogin(c *gin.Context)
• func GetSlackUrl(c *gin.Context)
• func GetTeams(c *gin.Context)
• func GetUser(c *gin.Context)
• func GetUserRepos(c *gin.Context)
• func IndentedJSON(c *gin.Context, code int, obj interface{})
• func PostOrg(c *gin.Context)
• func PostRepo(c *gin.Context)
• func RegisterSlackUrl(c *gin.Context)
• func TurnOffRepo(c context.Context, user *model.User, repo *model.Repo, ...) error
• func TurnOnRepoFailFast(c context.Context, user *model.User, caps *model.Capabilities, ...) (*model.Repo, error)
• func TurnOnRepoQuiet(c context.Context, user *model.User, owner, name, baseURL string) (*model.Repo, error)
• func UpdateSlackUrl(c *gin.Context)
• func UserDeleteSlackUrl(c *gin.Context)
• func UserGetSlackUrl(c *gin.Context)
• func UserRegisterSlackUrl(c *gin.Context)
• func UserUpdateSlackUrl(c *gin.Context)
• func Validate(c *gin.Context)
• type UrlHolder

Functions

func AdminDeleteOrg

func AdminDeleteOrg(c *gin.Context)

AdminDeleteOrg deletes any org and all repos for that org from the database and unregisters their hooks. only should be called by an admin user, as it works across accounts.

func AdminDeleteRepo

func AdminDeleteRepo(c *gin.Context)

func AdminStats

func AdminStats(c *gin.Context)

func CheckAdmin

func CheckAdmin(c *gin.Context)

func Convert

func Convert(c *gin.Context)

func DeleteOrg

func DeleteOrg(c *gin.Context)

DeleteOrg deletes an org and all repos for that org from the database and unregisters their hooks.

func DeleteRepo

func DeleteRepo(c *gin.Context)

DeleteRepo deletes a repository configuration.

func DeleteSlackUrl

func DeleteSlackUrl(c *gin.Context)

func DeleteUser

func DeleteUser(c *gin.Context)

DeleteUser removes the currently authenticated user and all associated repositories from the database.

func GetAllConfigurationSubtree

func GetAllConfigurationSubtree(c *gin.Context)

func GetAllRepos

func GetAllRepos(c *gin.Context)

GetAllRepos gets all public repositories managed by Checks-Out.

func GetAllReposCount

func GetAllReposCount(c *gin.Context)

GetAllReposCount gets the count of all repositories managed by Checks-Out.

func GetConfig

func GetConfig(c *gin.Context)

GetConfig gets the parsed configuration file.

func GetEnabledOrgs

func GetEnabledOrgs(c *gin.Context)

GetEnabledOrgs gets the list of organizations monitored by the service.

func GetMaintainer

func GetMaintainer(c *gin.Context)

GetMaintainer gets the MAINTAINER configuration file.

func GetOrgRepos

func GetOrgRepos(c *gin.Context)

GetOrgRepos gets the active org repository list for the current user.

func GetOrgs

func GetOrgs(c *gin.Context)

GetOrgs gets the list of user organizations.

func GetRepo

func GetRepo(c *gin.Context)

GetRepo gets the repository by slug.

func GetReposForUserLogin

func GetReposForUserLogin(c *gin.Context)

func GetSlackUrl

func GetSlackUrl(c *gin.Context)

func GetTeams

func GetTeams(c *gin.Context)

GetTeams gets the list of teams.

func GetUser

func GetUser(c *gin.Context)

GetUser gets the currently authenticated user.

func GetUserRepos

func GetUserRepos(c *gin.Context)

GetUserRepos gets the user's repository list.

func IndentedJSON

func IndentedJSON(c *gin.Context, code int, obj interface{})

func PostOrg

func PostOrg(c *gin.Context)

PostRepo activates a new repository.

func PostRepo

func PostRepo(c *gin.Context)

PostRepo activates a new repository.

func RegisterSlackUrl

func RegisterSlackUrl(c *gin.Context)

func TurnOffRepo

func TurnOffRepo(c context.Context, user *model.User, repo *model.Repo, owner, name, baseURL string) error

func TurnOnRepoFailFast

func TurnOnRepoFailFast(c context.Context, user *model.User, caps *model.Capabilities, owner, name, baseURL string) (*model.Repo, error)

TurnOnRepoFailFast enables the repository. If already activated then return an error. Validate the configuration files.

func TurnOnRepoQuiet

func TurnOnRepoQuiet(c context.Context, user *model.User, owner, name, baseURL string) (*model.Repo, error)

TurnOnRepoQuiet enables the repository. If already activated then do nothing. Do not validate the configuration files.

func UpdateSlackUrl

func UpdateSlackUrl(c *gin.Context)

func UserDeleteSlackUrl

func UserDeleteSlackUrl(c *gin.Context)

func UserGetSlackUrl

func UserGetSlackUrl(c *gin.Context)

func UserRegisterSlackUrl

func UserRegisterSlackUrl(c *gin.Context)

func UserUpdateSlackUrl

func UserUpdateSlackUrl(c *gin.Context)

func Validate

func Validate(c *gin.Context)

Validate validates the configuration and MAINTAINER files.

Types

type UrlHolder

type UrlHolder struct {
	Url string `json:"url"`
}