api

Documentation

Index

• Constants
• Variables
• func AuthMiddleware(logger logging.Logger, authService auth.Service) func(next http.Handler) http.Handler
• func GenerateJWT(secret []byte, accessKeyID string, issuedAt, expiresAt time.Time) (string, error)
• func Int64Ptr(n int64) *int64
• func Int64Value(p *int64) int64
• func IsStatusCodeOK(statusCode int) bool
• func MetricsMiddleware(swagger *openapi3.Swagger) func(http.Handler) http.Handler
• func NewHandlerWithDefault(root http.FileSystem, handler http.Handler, defaultPath string, ...) http.Handler
• func NewUIHandler(authService auth.Service, gatewayDomains []string) http.Handler
• func OapiRequestValidatorWithOptions(swagger *openapi3.Swagger, options *openapi3filter.Options) func(http.Handler) http.Handler
• func Serve(catalog catalog.Interface, authService auth.Service, ...) http.Handler
• func StringPtr(s string) *string
• func StringValue(s *string) string
• type Controller
  • func NewController(catalog catalog.Interface, authService auth.Service, ...) *Controller
  • func (c *Controller) AddGroupMembership(w http.ResponseWriter, r *http.Request, groupID string, userID string)
  • func (c *Controller) AttachPolicyToGroup(w http.ResponseWriter, r *http.Request, groupID string, policyID string)
  • func (c *Controller) AttachPolicyToUser(w http.ResponseWriter, r *http.Request, userID string, policyID string)
  • func (c *Controller) Commit(w http.ResponseWriter, r *http.Request, body CommitJSONRequestBody, ...)
  • func (c *Controller) CreateBranch(w http.ResponseWriter, r *http.Request, body CreateBranchJSONRequestBody, ...)
  • func (c *Controller) CreateCredentials(w http.ResponseWriter, r *http.Request, userID string)
  • func (c *Controller) CreateGroup(w http.ResponseWriter, r *http.Request, body CreateGroupJSONRequestBody)
  • func (c *Controller) CreatePolicy(w http.ResponseWriter, r *http.Request, body CreatePolicyJSONRequestBody)
  • func (c *Controller) CreateRepository(w http.ResponseWriter, r *http.Request, body CreateRepositoryJSONRequestBody, ...)
  • func (c *Controller) CreateSymlinkFile(w http.ResponseWriter, r *http.Request, repository string, branch string, ...)
  • func (c *Controller) CreateTag(w http.ResponseWriter, r *http.Request, body CreateTagJSONRequestBody, ...)
  • func (c *Controller) CreateUser(w http.ResponseWriter, r *http.Request, body CreateUserJSONRequestBody)
  • func (c *Controller) DeleteBranch(w http.ResponseWriter, r *http.Request, repository string, branch string)
  • func (c *Controller) DeleteCredentials(w http.ResponseWriter, r *http.Request, userID string, accessKeyID string)
  • func (c *Controller) DeleteGroup(w http.ResponseWriter, r *http.Request, groupID string)
  • func (c *Controller) DeleteGroupMembership(w http.ResponseWriter, r *http.Request, groupID string, userID string)
  • func (c *Controller) DeleteObject(w http.ResponseWriter, r *http.Request, repository string, branch string, ...)
  • func (c *Controller) DeletePolicy(w http.ResponseWriter, r *http.Request, policyID string)
  • func (c *Controller) DeleteRepository(w http.ResponseWriter, r *http.Request, repository string)
  • func (c *Controller) DeleteTag(w http.ResponseWriter, r *http.Request, repository string, tag string)
  • func (c *Controller) DeleteUser(w http.ResponseWriter, r *http.Request, userID string)
  • func (c *Controller) DetachPolicyFromGroup(w http.ResponseWriter, r *http.Request, groupID string, policyID string)
  • func (c *Controller) DetachPolicyFromUser(w http.ResponseWriter, r *http.Request, userID string, policyID string)
  • func (c *Controller) DiffBranch(w http.ResponseWriter, r *http.Request, repository string, branch string, ...)
  • func (c *Controller) DiffRefs(w http.ResponseWriter, r *http.Request, repository string, leftRef string, ...)
  • func (c *Controller) DumpRefs(w http.ResponseWriter, r *http.Request, repository string)
  • func (c *Controller) GetBranch(w http.ResponseWriter, r *http.Request, repository string, branch string)
  • func (c *Controller) GetCommit(w http.ResponseWriter, r *http.Request, repository string, commitID string)
  • func (c *Controller) GetConfig(w http.ResponseWriter, r *http.Request)
  • func (c *Controller) GetCredentials(w http.ResponseWriter, r *http.Request, userID string, accessKeyID string)
  • func (c *Controller) GetCurrentUser(w http.ResponseWriter, r *http.Request)
  • func (c *Controller) GetGroup(w http.ResponseWriter, r *http.Request, groupID string)
  • func (c *Controller) GetMetaRange(w http.ResponseWriter, r *http.Request, repository string, metaRange string)
  • func (c *Controller) GetObject(w http.ResponseWriter, r *http.Request, repository string, ref string, ...)
  • func (c *Controller) GetPhysicalAddress(w http.ResponseWriter, r *http.Request, repository string, branch string, ...)
  • func (c *Controller) GetPolicy(w http.ResponseWriter, r *http.Request, policyID string)
  • func (c *Controller) GetRange(w http.ResponseWriter, r *http.Request, repository string, pRange string)
  • func (c *Controller) GetRepository(w http.ResponseWriter, r *http.Request, repository string)
  • func (c *Controller) GetRun(w http.ResponseWriter, r *http.Request, repository string, runID string)
  • func (c *Controller) GetRunHookOutput(w http.ResponseWriter, r *http.Request, repository string, runID string, ...)
  • func (c *Controller) GetTag(w http.ResponseWriter, r *http.Request, repository string, tag string)
  • func (c *Controller) GetUnderlyingProperties(w http.ResponseWriter, r *http.Request, repository string, ref string, ...)
  • func (c *Controller) GetUser(w http.ResponseWriter, r *http.Request, userID string)
  • func (c *Controller) HealthCheck(w http.ResponseWriter, _ *http.Request)
  • func (c *Controller) LinkPhysicalAddress(w http.ResponseWriter, r *http.Request, ...)
  • func (c *Controller) ListBranches(w http.ResponseWriter, r *http.Request, repository string, ...)
  • func (c *Controller) ListGroupMembers(w http.ResponseWriter, r *http.Request, groupID string, ...)
  • func (c *Controller) ListGroupPolicies(w http.ResponseWriter, r *http.Request, groupID string, ...)
  • func (c *Controller) ListGroups(w http.ResponseWriter, r *http.Request, params ListGroupsParams)
  • func (c *Controller) ListObjects(w http.ResponseWriter, r *http.Request, repository string, ref string, ...)
  • func (c *Controller) ListPolicies(w http.ResponseWriter, r *http.Request, params ListPoliciesParams)
  • func (c *Controller) ListRepositories(w http.ResponseWriter, r *http.Request, params ListRepositoriesParams)
  • func (c *Controller) ListRepositoryRuns(w http.ResponseWriter, r *http.Request, repository string, ...)
  • func (c *Controller) ListRunHooks(w http.ResponseWriter, r *http.Request, repository string, runID string, ...)
  • func (c *Controller) ListTags(w http.ResponseWriter, r *http.Request, repository string, ...)
  • func (c *Controller) ListUserCredentials(w http.ResponseWriter, r *http.Request, userID string, ...)
  • func (c *Controller) ListUserGroups(w http.ResponseWriter, r *http.Request, userID string, ...)
  • func (c *Controller) ListUserPolicies(w http.ResponseWriter, r *http.Request, userID string, ...)
  • func (c *Controller) ListUsers(w http.ResponseWriter, r *http.Request, params ListUsersParams)
  • func (c *Controller) LogAction(ctx context.Context, action string)
  • func (c *Controller) LogBranchCommits(w http.ResponseWriter, r *http.Request, repository string, branch string, ...)
  • func (c *Controller) LogCommits(w http.ResponseWriter, r *http.Request, repository string, ref string, ...)
  • func (c *Controller) Login(w http.ResponseWriter, r *http.Request, body LoginJSONRequestBody)
  • func (c *Controller) Logout(w http.ResponseWriter, r *http.Request)
  • func (c *Controller) MergeIntoBranch(w http.ResponseWriter, r *http.Request, body MergeIntoBranchJSONRequestBody, ...)
  • func (c *Controller) ResetBranch(w http.ResponseWriter, r *http.Request, body ResetBranchJSONRequestBody, ...)
  • func (c *Controller) RestoreRefs(w http.ResponseWriter, r *http.Request, body RestoreRefsJSONRequestBody, ...)
  • func (c *Controller) RevertBranch(w http.ResponseWriter, r *http.Request, body RevertBranchJSONRequestBody, ...)
  • func (c *Controller) Setup(w http.ResponseWriter, r *http.Request, body SetupJSONRequestBody)
  • func (c *Controller) StageObject(w http.ResponseWriter, r *http.Request, body StageObjectJSONRequestBody, ...)
  • func (c *Controller) StatObject(w http.ResponseWriter, r *http.Request, repository string, ref string, ...)
  • func (c *Controller) UpdatePolicy(w http.ResponseWriter, r *http.Request, body UpdatePolicyJSONRequestBody, ...)
  • func (c *Controller) UploadObject(w http.ResponseWriter, r *http.Request, repository string, branch string, ...)
• type LoginRequestData
• type LoginResponseData

Constants

const (
	// DefaultMaxPerPage is the maximum amount of results returned for paginated queries to the API
	DefaultMaxPerPage int = 1000

	UserContextKey contextKey = "user"
)

const (
	DefaultLoginExpiration = time.Hour * 24 * 7
	JWTCookieName          = "access_token"
)

const (
	RequestIDHeaderName = "X-Request-ID"
	LoggerServiceName   = "rest_api"
	BaseURL             = "/api/v1"
)

const JWTAuthorizationHeaderName = "X-JWT-Authorization"

Variables

var (
	ErrUnexpectedSigningMethod = errors.New("unexpected signing method")
	ErrAuthenticationFailed    = errors.New("error authenticating request")
)

Functions

func AuthMiddleware

func AuthMiddleware(logger logging.Logger, authService auth.Service) func(next http.Handler) http.Handler

func GenerateJWT

func GenerateJWT(secret []byte, accessKeyID string, issuedAt, expiresAt time.Time) (string, error)

func Int64Ptr

func Int64Ptr(n int64) *int64

func Int64Value

func Int64Value(p *int64) int64

func IsStatusCodeOK

func IsStatusCodeOK(statusCode int) bool

func MetricsMiddleware

func MetricsMiddleware(swagger *openapi3.Swagger) func(http.Handler) http.Handler

func NewHandlerWithDefault

func NewHandlerWithDefault(root http.FileSystem, handler http.Handler, defaultPath string, gatewayDomains []string) http.Handler

func NewUIHandler

func NewUIHandler(authService auth.Service, gatewayDomains []string) http.Handler

func OapiRequestValidatorWithOptions

func OapiRequestValidatorWithOptions(swagger *openapi3.Swagger, options *openapi3filter.Options) func(http.Handler) http.Handler

OapiRequestValidatorWithOptions Creates middleware to validate request by swagger spec. This middleware is good for net/http either since go-chi is 100% compatible with net/http. The original implementation can be found at https://github.com/deepmap/oapi-codegen/blob/master/pkg/chi-middleware/oapi_validate.go Used our own implementation in order to:

1. Use the latest version kin-openapi (can switch back when oapi-codegen will be updated)
2. For file upload wanted to skip body validation for two reasons: a. didn't find a way for the validator to accept any file content type b. didn't want the validator to read the complete request body for the specific request

func Serve

func Serve(
	catalog catalog.Interface,
	authService auth.Service,
	blockAdapter block.Adapter,
	metadataManager auth.MetadataManager,
	migrator db.Migrator,
	collector stats.Collector,
	cloudMetadataProvider cloud.MetadataProvider,
	actions actionsHandler,
	logger logging.Logger,
	gatewayDomains []string,
) http.Handler

func StringPtr

func StringPtr(s string) *string

func StringValue

func StringValue(s *string) string

Types

type Controller

type Controller struct {
	Catalog               catalog.Interface
	Auth                  auth.Service
	BlockAdapter          block.Adapter
	MetadataManager       auth.MetadataManager
	Migrator              db.Migrator
	Collector             stats.Collector
	CloudMetadataProvider cloud.MetadataProvider
	Actions               actionsHandler
	Logger                logging.Logger
}

func NewController

func NewController(
	catalog catalog.Interface,
	authService auth.Service,
	blockAdapter block.Adapter,
	metadataManager auth.MetadataManager,
	migrator db.Migrator,
	collector stats.Collector,
	cloudMetadataProvider cloud.MetadataProvider,
	actions actionsHandler,
	logger logging.Logger,
) *Controller

func (*Controller) AddGroupMembership

func (c *Controller) AddGroupMembership(w http.ResponseWriter, r *http.Request, groupID string, userID string)

func (*Controller) AttachPolicyToGroup

func (c *Controller) AttachPolicyToGroup(w http.ResponseWriter, r *http.Request, groupID string, policyID string)

func (*Controller) AttachPolicyToUser

func (c *Controller) AttachPolicyToUser(w http.ResponseWriter, r *http.Request, userID string, policyID string)

func (*Controller) Commit

func (c *Controller) Commit(w http.ResponseWriter, r *http.Request, body CommitJSONRequestBody, repository string, branch string)

func (*Controller) CreateBranch

func (c *Controller) CreateBranch(w http.ResponseWriter, r *http.Request, body CreateBranchJSONRequestBody, repository string)

func (*Controller) CreateCredentials

func (c *Controller) CreateCredentials(w http.ResponseWriter, r *http.Request, userID string)

func (*Controller) CreateGroup

func (c *Controller) CreateGroup(w http.ResponseWriter, r *http.Request, body CreateGroupJSONRequestBody)

func (*Controller) CreatePolicy

func (c *Controller) CreatePolicy(w http.ResponseWriter, r *http.Request, body CreatePolicyJSONRequestBody)

func (*Controller) CreateRepository

func (c *Controller) CreateRepository(w http.ResponseWriter, r *http.Request, body CreateRepositoryJSONRequestBody, params CreateRepositoryParams)

func (*Controller) CreateSymlinkFile

func (c *Controller) CreateSymlinkFile(w http.ResponseWriter, r *http.Request, repository string, branch string, params CreateSymlinkFileParams)

func (*Controller) CreateTag

func (c *Controller) CreateTag(w http.ResponseWriter, r *http.Request, body CreateTagJSONRequestBody, repository string)

func (*Controller) CreateUser

func (c *Controller) CreateUser(w http.ResponseWriter, r *http.Request, body CreateUserJSONRequestBody)

func (*Controller) DeleteBranch

func (c *Controller) DeleteBranch(w http.ResponseWriter, r *http.Request, repository string, branch string)

func (*Controller) DeleteCredentials

func (c *Controller) DeleteCredentials(w http.ResponseWriter, r *http.Request, userID string, accessKeyID string)

func (*Controller) DeleteGroup

func (c *Controller) DeleteGroup(w http.ResponseWriter, r *http.Request, groupID string)

func (*Controller) DeleteGroupMembership

func (c *Controller) DeleteGroupMembership(w http.ResponseWriter, r *http.Request, groupID string, userID string)

func (*Controller) DeleteObject

func (c *Controller) DeleteObject(w http.ResponseWriter, r *http.Request, repository string, branch string, params DeleteObjectParams)

func (*Controller) DeletePolicy

func (c *Controller) DeletePolicy(w http.ResponseWriter, r *http.Request, policyID string)

func (*Controller) DeleteRepository

func (c *Controller) DeleteRepository(w http.ResponseWriter, r *http.Request, repository string)

func (*Controller) DeleteTag

func (c *Controller) DeleteTag(w http.ResponseWriter, r *http.Request, repository string, tag string)

func (*Controller) DeleteUser

func (c *Controller) DeleteUser(w http.ResponseWriter, r *http.Request, userID string)

func (*Controller) DetachPolicyFromGroup

func (c *Controller) DetachPolicyFromGroup(w http.ResponseWriter, r *http.Request, groupID string, policyID string)

func (*Controller) DetachPolicyFromUser

func (c *Controller) DetachPolicyFromUser(w http.ResponseWriter, r *http.Request, userID string, policyID string)

func (*Controller) DiffBranch

func (c *Controller) DiffBranch(w http.ResponseWriter, r *http.Request, repository string, branch string, params DiffBranchParams)

func (*Controller) DiffRefs

func (c *Controller) DiffRefs(w http.ResponseWriter, r *http.Request, repository string, leftRef string, rightRef string, params DiffRefsParams)

func (*Controller) DumpRefs

func (c *Controller) DumpRefs(w http.ResponseWriter, r *http.Request, repository string)

func (*Controller) GetBranch

func (c *Controller) GetBranch(w http.ResponseWriter, r *http.Request, repository string, branch string)

func (*Controller) GetCommit

func (c *Controller) GetCommit(w http.ResponseWriter, r *http.Request, repository string, commitID string)

func (*Controller) GetConfig

func (c *Controller) GetConfig(w http.ResponseWriter, r *http.Request)

func (*Controller) GetCredentials

func (c *Controller) GetCredentials(w http.ResponseWriter, r *http.Request, userID string, accessKeyID string)

func (*Controller) GetCurrentUser

func (c *Controller) GetCurrentUser(w http.ResponseWriter, r *http.Request)

func (*Controller) GetGroup

func (c *Controller) GetGroup(w http.ResponseWriter, r *http.Request, groupID string)

func (*Controller) GetMetaRange

func (c *Controller) GetMetaRange(w http.ResponseWriter, r *http.Request, repository string, metaRange string)

func (*Controller) GetObject

func (c *Controller) GetObject(w http.ResponseWriter, r *http.Request, repository string, ref string, params GetObjectParams)

func (*Controller) GetPhysicalAddress

func (c *Controller) GetPhysicalAddress(w http.ResponseWriter, r *http.Request, repository string, branch string, params GetPhysicalAddressParams)

func (*Controller) GetPolicy

func (c *Controller) GetPolicy(w http.ResponseWriter, r *http.Request, policyID string)

func (*Controller) GetRange

func (c *Controller) GetRange(w http.ResponseWriter, r *http.Request, repository string, pRange string)

func (*Controller) GetRepository

func (c *Controller) GetRepository(w http.ResponseWriter, r *http.Request, repository string)

func (*Controller) GetRun

func (c *Controller) GetRun(w http.ResponseWriter, r *http.Request, repository string, runID string)

func (*Controller) GetRunHookOutput

func (c *Controller) GetRunHookOutput(w http.ResponseWriter, r *http.Request, repository string, runID string, hookRunID string)

func (*Controller) GetTag

func (c *Controller) GetTag(w http.ResponseWriter, r *http.Request, repository string, tag string)

func (*Controller) GetUnderlyingProperties

func (c *Controller) GetUnderlyingProperties(w http.ResponseWriter, r *http.Request, repository string, ref string, params GetUnderlyingPropertiesParams)

func (*Controller) GetUser

func (c *Controller) GetUser(w http.ResponseWriter, r *http.Request, userID string)

func (*Controller) HealthCheck

func (c *Controller) HealthCheck(w http.ResponseWriter, _ *http.Request)

func (*Controller) LinkPhysicalAddress

func (c *Controller) LinkPhysicalAddress(w http.ResponseWriter, r *http.Request, body LinkPhysicalAddressJSONRequestBody, repository string, branch string, params LinkPhysicalAddressParams)

func (*Controller) ListBranches

func (c *Controller) ListBranches(w http.ResponseWriter, r *http.Request, repository string, params ListBranchesParams)

func (*Controller) ListGroupMembers

func (c *Controller) ListGroupMembers(w http.ResponseWriter, r *http.Request, groupID string, params ListGroupMembersParams)

func (*Controller) ListGroupPolicies

func (c *Controller) ListGroupPolicies(w http.ResponseWriter, r *http.Request, groupID string, params ListGroupPoliciesParams)

func (*Controller) ListGroups

func (c *Controller) ListGroups(w http.ResponseWriter, r *http.Request, params ListGroupsParams)

func (*Controller) ListObjects

func (c *Controller) ListObjects(w http.ResponseWriter, r *http.Request, repository string, ref string, params ListObjectsParams)

func (*Controller) ListPolicies

func (c *Controller) ListPolicies(w http.ResponseWriter, r *http.Request, params ListPoliciesParams)

func (*Controller) ListRepositories

func (c *Controller) ListRepositories(w http.ResponseWriter, r *http.Request, params ListRepositoriesParams)

func (*Controller) ListRepositoryRuns

func (c *Controller) ListRepositoryRuns(w http.ResponseWriter, r *http.Request, repository string, params ListRepositoryRunsParams)

func (*Controller) ListRunHooks

func (c *Controller) ListRunHooks(w http.ResponseWriter, r *http.Request, repository string, runID string, params ListRunHooksParams)

func (*Controller) ListTags

func (c *Controller) ListTags(w http.ResponseWriter, r *http.Request, repository string, params ListTagsParams)

func (*Controller) ListUserCredentials

func (c *Controller) ListUserCredentials(w http.ResponseWriter, r *http.Request, userID string, params ListUserCredentialsParams)

func (*Controller) ListUserGroups

func (c *Controller) ListUserGroups(w http.ResponseWriter, r *http.Request, userID string, params ListUserGroupsParams)

func (*Controller) ListUserPolicies

func (c *Controller) ListUserPolicies(w http.ResponseWriter, r *http.Request, userID string, params ListUserPoliciesParams)

func (*Controller) ListUsers

func (c *Controller) ListUsers(w http.ResponseWriter, r *http.Request, params ListUsersParams)

func (*Controller) LogAction

func (c *Controller) LogAction(ctx context.Context, action string)

func (*Controller) LogBranchCommits

func (c *Controller) LogBranchCommits(w http.ResponseWriter, r *http.Request, repository string, branch string, params LogBranchCommitsParams)

LogBranchCommits deprecated replaced by LogCommits

func (*Controller) LogCommits

func (c *Controller) LogCommits(w http.ResponseWriter, r *http.Request, repository string, ref string, params LogCommitsParams)

func (*Controller) Login

func (c *Controller) Login(w http.ResponseWriter, r *http.Request, body LoginJSONRequestBody)

func (*Controller) Logout

func (c *Controller) Logout(w http.ResponseWriter, r *http.Request)

func (*Controller) MergeIntoBranch

func (c *Controller) MergeIntoBranch(w http.ResponseWriter, r *http.Request, body MergeIntoBranchJSONRequestBody, repository string, sourceRef string, destinationBranch string)

func (*Controller) ResetBranch

func (c *Controller) ResetBranch(w http.ResponseWriter, r *http.Request, body ResetBranchJSONRequestBody, repository string, branch string)

func (*Controller) RestoreRefs

func (c *Controller) RestoreRefs(w http.ResponseWriter, r *http.Request, body RestoreRefsJSONRequestBody, repository string)

func (*Controller) RevertBranch

func (c *Controller) RevertBranch(w http.ResponseWriter, r *http.Request, body RevertBranchJSONRequestBody, repository string, branch string)

func (*Controller) Setup

func (c *Controller) Setup(w http.ResponseWriter, r *http.Request, body SetupJSONRequestBody)

func (*Controller) StageObject

func (c *Controller) StageObject(w http.ResponseWriter, r *http.Request, body StageObjectJSONRequestBody, repository string, branch string, params StageObjectParams)

func (*Controller) StatObject

func (c *Controller) StatObject(w http.ResponseWriter, r *http.Request, repository string, ref string, params StatObjectParams)

func (*Controller) UpdatePolicy

func (c *Controller) UpdatePolicy(w http.ResponseWriter, r *http.Request, body UpdatePolicyJSONRequestBody, policyID string)

func (*Controller) UploadObject

func (c *Controller) UploadObject(w http.ResponseWriter, r *http.Request, repository string, branch string, params UploadObjectParams)

type LoginRequestData

type LoginRequestData struct {
	AccessKeyID     string `json:"access_key_id"`
	SecretAccessKey string `json:"secret_access_key"`
}

type LoginResponseData

type LoginResponseData struct {
	Token string `json:"token"`
}