api

package

v1.20.0 Latest Latest Go to latest Published: Apr 16, 2024 License: Apache-2.0 Imports: 67 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/treeverse/lakefs

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func AuthMiddleware(logger logging.Logger, swagger *openapi3.Swagger, ...) func(next http.Handler) http.Handler
func EtagMiddleware(root fs.FS, next http.Handler) http.Handler
func GenerateJWTLogin(secret []byte, userID string, issuedAt, expiresAt time.Time) (string, error)
func GenericAuthMiddleware(logger logging.Logger, authenticator auth.Authenticator, ...) (func(next http.Handler) http.Handler, error)
func InvalidAPIEndpointHandler(w http.ResponseWriter, r *http.Request)
func MetricsMiddleware(swagger *openapi3.Swagger) func(http.Handler) http.Handler
func NewHandlerWithDefault(fileSystem http.FileSystem, handler http.Handler, gatewayDomains []string) http.Handler
func NewInjectIndexFS(fsys fs.FS, name string, marker string, snippets []params.CodeSnippet) (fs.FS, error)
func NewLogoutHandler(sessionStore sessions.Store, logger logging.Logger, logoutRedirectURL string) http.HandlerFunc
func NewS3GatewayEndpointErrorHandler(gatewayDomains []string) http.Handler
func NewUIHandler(gatewayDomains []string, snippets []params.CodeSnippet) http.Handler
func OapiRequestValidatorWithOptions(swagger *openapi3.Swagger, options *openapi3filter.Options) func(http.Handler) http.Handler
func Serve(cfg *config.Config, catalog *catalog.Catalog, ...) http.Handler
type AuditChecker
type Controller
- func NewController(cfg *config.Config, catalog *catalog.Catalog, authenticator auth.Authenticator, ...) *Controller
- func (c *Controller) AbortPresignMultipartUpload(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) AddGroupMembership(w http.ResponseWriter, r *http.Request, groupID, userID string)
- func (c *Controller) AttachPolicyToGroup(w http.ResponseWriter, r *http.Request, groupID, policyID string)
- func (c *Controller) AttachPolicyToUser(w http.ResponseWriter, r *http.Request, userID, policyID string)
- func (c *Controller) CherryPick(w http.ResponseWriter, r *http.Request, body apigen.CherryPickJSONRequestBody, ...)
- func (c *Controller) Commit(w http.ResponseWriter, r *http.Request, body apigen.CommitJSONRequestBody, ...)
- func (c *Controller) CompletePresignMultipartUpload(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) CopyObject(w http.ResponseWriter, r *http.Request, body apigen.CopyObjectJSONRequestBody, ...)
- func (c *Controller) CreateBranch(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) CreateBranchProtectionRulePreflight(w http.ResponseWriter, r *http.Request, repository string)
- func (c *Controller) CreateCommitRecord(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) CreateCredentials(w http.ResponseWriter, r *http.Request, userID string)
- func (c *Controller) CreateGroup(w http.ResponseWriter, r *http.Request, body apigen.CreateGroupJSONRequestBody)
- func (c *Controller) CreatePolicy(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) CreatePresignMultipartUpload(w http.ResponseWriter, r *http.Request, repository string, branch string, ...)
- func (c *Controller) CreateRepository(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) CreateSymlinkFile(w http.ResponseWriter, r *http.Request, repository, branch string, ...)
- func (c *Controller) CreateTag(w http.ResponseWriter, r *http.Request, body apigen.CreateTagJSONRequestBody, ...)
- func (c *Controller) CreateUser(w http.ResponseWriter, r *http.Request, body apigen.CreateUserJSONRequestBody)
- func (c *Controller) CreateUserExternalPrincipal(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) DeleteBranch(w http.ResponseWriter, r *http.Request, repository, branch string, ...)
- func (c *Controller) DeleteCredentials(w http.ResponseWriter, r *http.Request, userID, accessKeyID string)
- func (c *Controller) DeleteGCRules(w http.ResponseWriter, r *http.Request, repository string)
- func (c *Controller) DeleteGroup(w http.ResponseWriter, r *http.Request, groupID string)
- func (c *Controller) DeleteGroupMembership(w http.ResponseWriter, r *http.Request, groupID, userID string)
- func (c *Controller) DeleteObject(w http.ResponseWriter, r *http.Request, repository, branch string, ...)
- func (c *Controller) DeleteObjects(w http.ResponseWriter, r *http.Request, ...)
- 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) DeleteRepositoryMetadata(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) DeleteTag(w http.ResponseWriter, r *http.Request, repository, tag string, ...)
- func (c *Controller) DeleteUser(w http.ResponseWriter, r *http.Request, userID string)
- func (c *Controller) DeleteUserExternalPrincipal(w http.ResponseWriter, r *http.Request, userID string, ...)
- func (c *Controller) DetachPolicyFromGroup(w http.ResponseWriter, r *http.Request, groupID, policyID string)
- func (c *Controller) DetachPolicyFromUser(w http.ResponseWriter, r *http.Request, userID, policyID string)
- func (c *Controller) DiffBranch(w http.ResponseWriter, r *http.Request, repository, branch string, ...)
- func (c *Controller) DiffRefs(w http.ResponseWriter, r *http.Request, repository, leftRef, rightRef string, ...)
- func (c *Controller) DumpRefs(w http.ResponseWriter, r *http.Request, repository string)
- func (c *Controller) DumpStatus(w http.ResponseWriter, r *http.Request, repository string, ...)
- func (c *Controller) DumpSubmit(w http.ResponseWriter, r *http.Request, repository string)
- func (c *Controller) ExternalPrincipalLogin(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) FindMergeBase(w http.ResponseWriter, r *http.Request, repository string, sourceRef string, ...)
- func (c *Controller) GetAuthCapabilities(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetBranch(w http.ResponseWriter, r *http.Request, repository, branch string)
- func (c *Controller) GetBranchProtectionRules(w http.ResponseWriter, r *http.Request, repository string)
- func (c *Controller) GetCommit(w http.ResponseWriter, r *http.Request, repository, commitID string)
- func (c *Controller) GetConfig(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetCredentials(w http.ResponseWriter, r *http.Request, userID, accessKeyID string)
- func (c *Controller) GetCurrentUser(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetExternalPrincipal(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) GetGCRules(w http.ResponseWriter, r *http.Request, repository string)
- func (c *Controller) GetGarbageCollectionConfig(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetGroup(w http.ResponseWriter, r *http.Request, groupID string)
- func (c *Controller) GetGroupACL(w http.ResponseWriter, r *http.Request, groupID string)
- func (c *Controller) GetLakeFSVersion(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetMetaRange(w http.ResponseWriter, r *http.Request, repository, metaRange string)
- func (c *Controller) GetObject(w http.ResponseWriter, r *http.Request, repository, ref string, ...)
- func (c *Controller) GetPhysicalAddress(w http.ResponseWriter, r *http.Request, repository, 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, pRange string)
- func (c *Controller) GetRepository(w http.ResponseWriter, r *http.Request, repository string)
- func (c *Controller) GetRepositoryMetadata(w http.ResponseWriter, r *http.Request, repository string)
- func (c *Controller) GetRun(w http.ResponseWriter, r *http.Request, repository, runID string)
- func (c *Controller) GetRunHookOutput(w http.ResponseWriter, r *http.Request, repository, runID, hookRunID string)
- func (c *Controller) GetSetupState(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetStorageConfig(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetTag(w http.ResponseWriter, r *http.Request, repository, tag string)
- func (c *Controller) GetUnderlyingProperties(w http.ResponseWriter, r *http.Request, repository, ref string, ...)
- func (c *Controller) GetUsageReportSummary(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetUser(w http.ResponseWriter, r *http.Request, userID string)
- func (c *Controller) HardResetBranch(w http.ResponseWriter, r *http.Request, repository, branch string, ...)
- func (c *Controller) HeadObject(w http.ResponseWriter, r *http.Request, repository, ref string, ...)
- func (c *Controller) HealthCheck(w http.ResponseWriter, r *http.Request)
- func (c *Controller) ImportCancel(w http.ResponseWriter, r *http.Request, repository, branch string, ...)
- func (c *Controller) ImportStart(w http.ResponseWriter, r *http.Request, body apigen.ImportStartJSONRequestBody, ...)
- func (c *Controller) ImportStatus(w http.ResponseWriter, r *http.Request, repository, branch string, ...)
- func (c *Controller) InternalCreateBranchProtectionRule(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) InternalDeleteBranchProtectionRule(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) InternalDeleteGarbageCollectionRules(w http.ResponseWriter, r *http.Request, repository string)
- func (c *Controller) InternalGetBranchProtectionRules(w http.ResponseWriter, r *http.Request, repository string)
- func (c *Controller) InternalGetGarbageCollectionRules(w http.ResponseWriter, r *http.Request, repository string)
- func (c *Controller) InternalSetGarbageCollectionRules(w http.ResponseWriter, r *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 apigen.ListGroupsParams)
- func (c *Controller) ListObjects(w http.ResponseWriter, r *http.Request, repository, ref string, ...)
- func (c *Controller) ListPolicies(w http.ResponseWriter, r *http.Request, params apigen.ListPoliciesParams)
- func (c *Controller) ListRepositories(w http.ResponseWriter, r *http.Request, params apigen.ListRepositoriesParams)
- func (c *Controller) ListRepositoryRuns(w http.ResponseWriter, r *http.Request, repository string, ...)
- func (c *Controller) ListRunHooks(w http.ResponseWriter, r *http.Request, repository, 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) ListUserExternalPrincipals(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 apigen.ListUsersParams)
- func (c *Controller) LogAction(ctx context.Context, action string, r *http.Request, ...)
- func (c *Controller) LogCommits(w http.ResponseWriter, r *http.Request, repository, ref string, ...)
- func (c *Controller) Login(w http.ResponseWriter, r *http.Request, body apigen.LoginJSONRequestBody)
- func (c *Controller) MergeIntoBranch(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) PostStatsEvents(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) PrepareGarbageCollectionCommits(w http.ResponseWriter, r *http.Request, repository string)
- func (c *Controller) PrepareGarbageCollectionUncommitted(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) ResetBranch(w http.ResponseWriter, r *http.Request, body apigen.ResetBranchJSONRequestBody, ...)
- func (c *Controller) RestoreRefs(w http.ResponseWriter, r *http.Request, body apigen.RestoreRefsJSONRequestBody, ...)
- func (c *Controller) RestoreStatus(w http.ResponseWriter, r *http.Request, repository string, ...)
- func (c *Controller) RestoreSubmit(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) RevertBranch(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) SetBranchProtectionRules(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) SetGCRules(w http.ResponseWriter, r *http.Request, body apigen.SetGCRulesJSONRequestBody, ...)
- func (c *Controller) SetGarbageCollectionRulesPreflight(w http.ResponseWriter, r *http.Request, repository string)
- func (c *Controller) SetGroupACL(w http.ResponseWriter, r *http.Request, body apigen.SetGroupACLJSONRequestBody, ...)
- func (c *Controller) SetRepositoryMetadata(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) Setup(w http.ResponseWriter, r *http.Request, body apigen.SetupJSONRequestBody)
- func (c *Controller) SetupCommPrefs(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) StageObject(w http.ResponseWriter, r *http.Request, body apigen.StageObjectJSONRequestBody, ...)
- func (c *Controller) StatObject(w http.ResponseWriter, r *http.Request, repository, ref string, ...)
- func (c *Controller) StsLogin(w http.ResponseWriter, r *http.Request, body apigen.StsLoginJSONRequestBody)
- func (c *Controller) UpdatePolicy(w http.ResponseWriter, r *http.Request, ...)
- func (c *Controller) UploadObject(w http.ResponseWriter, r *http.Request, repository, branch string, ...)
- func (c *Controller) UploadObjectPreflight(w http.ResponseWriter, r *http.Request, repository, branch string, ...)
type CookieAuthConfig
type InjectSnippetsFS
- func (i *InjectSnippetsFS) Open(name string) (fs.File, error)
type Migrator
type OIDCConfig

Constants ¶

View Source

const (
	TokenSessionKeyName       = "token"
	InternalAuthSessionName   = "internal_auth_session"
	IDTokenClaimsSessionKey   = "id_token_claims"
	OIDCAuthSessionName       = "oidc_auth_session"
	SAMLTokenClaimsSessionKey = "saml_token_claims"
	SAMLAuthSessionName       = "saml_auth_session"
)

View Source

const (
	// DefaultMaxPerPage is the maximum number of results returned for paginated queries to the API
	DefaultMaxPerPage int = 1000
	// DefaultPerPage is the default number of results returned for paginated queries to the API
	DefaultPerPage int = 100

	DefaultMaxDeleteObjects = 1000
)

View Source

const (
	RequestIDHeaderName = "X-Request-ID"
	LoggerServiceName   = "rest_api"
)

View Source

const (
	LoginAudience = "login"
)

Variables ¶

View Source

var (
	ErrFailedToAccessStorage = errors.New("failed to access storage")
	ErrAuthenticatingRequest = errors.New("error authenticating request")
	ErrInvalidAPIEndpoint    = errors.New("invalid API endpoint")
	ErrRequestSizeExceeded   = errors.New("request size exceeded")
	ErrStorageNamespaceInUse = errors.New("storage namespace already in use")
)

Functions ¶

func AuthMiddleware ¶ added in v0.40.0

func AuthMiddleware(logger logging.Logger, swagger *openapi3.Swagger, authenticator auth.Authenticator, authService auth.Service, sessionStore sessions.Store, oidcConfig *OIDCConfig, cookieAuthConfig *CookieAuthConfig) func(next http.Handler) http.Handler

func EtagMiddleware ¶ added in v1.3.1

func EtagMiddleware(root fs.FS, next http.Handler) http.Handler

EtagMiddleware returns a new Etag middleware handler. It designs to work on embedded FS, where the content doesn't change. It calculates the Etag for each file on startup and serves it on each request.

func GenerateJWTLogin ¶ added in v0.63.0

func GenerateJWTLogin(secret []byte, userID string, issuedAt, expiresAt time.Time) (string, error)

GenerateJWTLogin creates a jwt token which can be used for authentication during login only, i.e. it will not work for password reset. It supports backward compatibility for creating a login jwt. The audience is not set for login token. Any audience will make the token invalid for login. No email is passed to support the ability of login for users via user/access keys which don't have an email yet

func GenericAuthMiddleware ¶ added in v0.104.0

func GenericAuthMiddleware(logger logging.Logger, authenticator auth.Authenticator, authService auth.Service, oidcConfig *OIDCConfig, cookieAuthConfig *CookieAuthConfig) (func(next http.Handler) http.Handler, error)

func InvalidAPIEndpointHandler ¶ added in v0.48.0

func InvalidAPIEndpointHandler(w http.ResponseWriter, r *http.Request)

InvalidAPIEndpointHandler returns ErrInvalidAPIEndpoint, and is currently being used to ensure that routes under the pattern it is used with in chi.Router.Mount (i.e. /api/v1) are not accessible.

func MetricsMiddleware ¶ added in v0.40.0

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

func NewHandlerWithDefault ¶

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

func NewInjectIndexFS ¶ added in v0.66.0

func NewInjectIndexFS(fsys fs.FS, name string, marker string, snippets []params.CodeSnippet) (fs.FS, error)

func NewLogoutHandler ¶

func NewLogoutHandler(sessionStore sessions.Store, logger logging.Logger, logoutRedirectURL string) http.HandlerFunc

NewLogoutHandler returns a handler to clear the user sessions and redirect the user to the login page.

func NewS3GatewayEndpointErrorHandler ¶ added in v0.70.2

func NewS3GatewayEndpointErrorHandler(gatewayDomains []string) http.Handler

func NewUIHandler ¶

func NewUIHandler(gatewayDomains []string, snippets []params.CodeSnippet) http.Handler

func OapiRequestValidatorWithOptions ¶ added in v0.40.0

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 Use our own implementation in order to:

Use the latest version kin-openapi (can switch back when oapi-codegen will be updated)
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(cfg *config.Config, catalog *catalog.Catalog, middlewareAuthenticator auth.Authenticator, authService auth.Service, authenticationService authentication.Service, blockAdapter block.Adapter, metadataManager auth.MetadataManager, migrator Migrator, collector stats.Collector, cloudMetadataProvider cloud.MetadataProvider, actions actionsHandler, auditChecker AuditChecker, logger logging.Logger, gatewayDomains []string, snippets []params.CodeSnippet, pathProvider upload.PathProvider, usageReporter stats.UsageReporterOperations) http.Handler

Types ¶

type AuditChecker ¶ added in v0.57.0

type AuditChecker interface {
	LastCheck() (*version.AuditResponse, error)
	CheckLatestVersion() (*version.LatestVersionResponse, error)
}

type Controller ¶

type Controller struct {
	Config                *config.Config
	Catalog               *catalog.Catalog
	Authenticator         auth.Authenticator
	Auth                  auth.Service
	Authentication        authentication.Service
	BlockAdapter          block.Adapter
	MetadataManager       auth.MetadataManager
	Migrator              Migrator
	Collector             stats.Collector
	CloudMetadataProvider cloud.MetadataProvider
	Actions               actionsHandler
	AuditChecker          AuditChecker
	Logger                logging.Logger

	PathProvider upload.PathProvider
	// contains filtered or unexported fields
}

func NewController ¶

func NewController(cfg *config.Config, catalog *catalog.Catalog, authenticator auth.Authenticator, authService auth.Service, authenticationService authentication.Service, blockAdapter block.Adapter, metadataManager auth.MetadataManager, migrator Migrator, collector stats.Collector, cloudMetadataProvider cloud.MetadataProvider, actions actionsHandler, auditChecker AuditChecker, logger logging.Logger, sessionStore sessions.Store, pathProvider upload.PathProvider, usageReporter stats.UsageReporterOperations) *Controller

func (*Controller) AbortPresignMultipartUpload ¶ added in v1.7.0

func (c *Controller) AbortPresignMultipartUpload(w http.ResponseWriter, r *http.Request, body apigen.AbortPresignMultipartUploadJSONRequestBody, repository string, branch string, uploadID string, params apigen.AbortPresignMultipartUploadParams)

func (*Controller) AddGroupMembership ¶ added in v0.40.0

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

func (*Controller) AttachPolicyToGroup ¶ added in v0.40.0

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

func (*Controller) AttachPolicyToUser ¶ added in v0.40.0

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

func (*Controller) CherryPick ¶ added in v0.97.0

func (c *Controller) CherryPick(w http.ResponseWriter, r *http.Request, body apigen.CherryPickJSONRequestBody, repository string, branch string)

func (*Controller) Commit ¶ added in v0.40.0

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

func (*Controller) CompletePresignMultipartUpload ¶ added in v1.7.0

func (c *Controller) CompletePresignMultipartUpload(w http.ResponseWriter, r *http.Request, body apigen.CompletePresignMultipartUploadJSONRequestBody, repository string, branch string, uploadID string, params apigen.CompletePresignMultipartUploadParams)

func (*Controller) CopyObject ¶ added in v0.90.0

func (c *Controller) CopyObject(w http.ResponseWriter, r *http.Request, body apigen.CopyObjectJSONRequestBody, repository, branch string, params apigen.CopyObjectParams)

func (*Controller) CreateBranch ¶ added in v0.40.0

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

func (*Controller) CreateBranchProtectionRulePreflight ¶ added in v0.102.0

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

func (*Controller) CreateCommitRecord ¶ added in v1.9.0

func (c *Controller) CreateCommitRecord(w http.ResponseWriter, r *http.Request, body apigen.CreateCommitRecordJSONRequestBody, repository string)

func (*Controller) CreateCredentials ¶ added in v0.40.0

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

func (*Controller) CreateGroup ¶ added in v0.40.0

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

func (*Controller) CreatePolicy ¶ added in v0.40.0

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

func (*Controller) CreatePresignMultipartUpload ¶ added in v1.7.0

func (c *Controller) CreatePresignMultipartUpload(w http.ResponseWriter, r *http.Request, repository string, branch string, params apigen.CreatePresignMultipartUploadParams)

func (*Controller) CreateRepository ¶ added in v0.40.0

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

func (*Controller) CreateSymlinkFile ¶ added in v0.40.0

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

func (*Controller) CreateTag ¶ added in v0.40.0

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

func (*Controller) CreateUser ¶ added in v0.40.0

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

func (*Controller) CreateUserExternalPrincipal ¶ added in v1.14.0

func (c *Controller) CreateUserExternalPrincipal(w http.ResponseWriter, r *http.Request, body apigen.CreateUserExternalPrincipalJSONRequestBody, userID string, params apigen.CreateUserExternalPrincipalParams)

func (*Controller) DeleteBranch ¶ added in v0.40.0

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

func (*Controller) DeleteCredentials ¶ added in v0.40.0

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

func (*Controller) DeleteGCRules ¶ added in v0.111.0

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

func (*Controller) DeleteGroup ¶ added in v0.40.0

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

func (*Controller) DeleteGroupMembership ¶ added in v0.40.0

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

func (*Controller) DeleteObject ¶ added in v0.40.0

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

func (*Controller) DeleteObjects ¶ added in v0.57.0

func (c *Controller) DeleteObjects(w http.ResponseWriter, r *http.Request, body apigen.DeleteObjectsJSONRequestBody, repository, branch string, params apigen.DeleteObjectsParams)

func (*Controller) DeletePolicy ¶ added in v0.40.0

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

func (*Controller) DeleteRepository ¶ added in v0.40.0

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

func (*Controller) DeleteRepositoryMetadata ¶ added in v1.8.0

func (c *Controller) DeleteRepositoryMetadata(w http.ResponseWriter, r *http.Request, body apigen.DeleteRepositoryMetadataJSONRequestBody, repository string)

func (*Controller) DeleteTag ¶ added in v0.40.0

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

func (*Controller) DeleteUser ¶ added in v0.40.0

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

func (*Controller) DeleteUserExternalPrincipal ¶ added in v1.14.0

func (c *Controller) DeleteUserExternalPrincipal(w http.ResponseWriter, r *http.Request, userID string, params apigen.DeleteUserExternalPrincipalParams)

func (*Controller) DetachPolicyFromGroup ¶ added in v0.40.0

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

func (*Controller) DetachPolicyFromUser ¶ added in v0.40.0

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

func (*Controller) DiffBranch ¶ added in v0.40.0

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

func (*Controller) DiffRefs ¶ added in v0.40.0

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

func (*Controller) DumpRefs ¶ added in v0.40.0

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

func (*Controller) DumpStatus ¶ added in v1.3.0

func (c *Controller) DumpStatus(w http.ResponseWriter, r *http.Request, repository string, params apigen.DumpStatusParams)

func (*Controller) DumpSubmit ¶ added in v1.3.0

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

func (*Controller) ExternalPrincipalLogin ¶ added in v1.18.0

func (c *Controller) ExternalPrincipalLogin(w http.ResponseWriter, r *http.Request, body apigen.ExternalPrincipalLoginJSONRequestBody)

func (*Controller) FindMergeBase ¶ added in v0.94.1

func (c *Controller) FindMergeBase(w http.ResponseWriter, r *http.Request, repository string, sourceRef string, destinationRef string)

func (*Controller) GetAuthCapabilities ¶ added in v0.64.0

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

func (*Controller) GetBranch ¶ added in v0.40.0

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

func (*Controller) GetBranchProtectionRules ¶ added in v0.52.0

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

func (*Controller) GetCommit ¶ added in v0.40.0

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

func (*Controller) GetConfig ¶ added in v0.40.0

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

func (*Controller) GetCredentials ¶ added in v0.40.0

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

func (*Controller) GetCurrentUser ¶ added in v0.40.0

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

func (*Controller) GetExternalPrincipal ¶ added in v1.14.1

func (c *Controller) GetExternalPrincipal(w http.ResponseWriter, r *http.Request, params apigen.GetExternalPrincipalParams)

func (*Controller) GetGCRules ¶ added in v0.111.0

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

func (*Controller) GetGarbageCollectionConfig ¶ added in v0.90.0

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

func (*Controller) GetGroup ¶ added in v0.40.0

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

func (*Controller) GetGroupACL ¶ added in v0.98.0

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

func (*Controller) GetLakeFSVersion ¶ added in v0.43.0

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

func (*Controller) GetMetaRange ¶ added in v0.40.0

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

func (*Controller) GetObject ¶ added in v0.40.0

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

func (*Controller) GetPhysicalAddress ¶ added in v0.40.0

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

func (*Controller) GetPolicy ¶ added in v0.40.0

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

func (*Controller) GetRange ¶ added in v0.40.0

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

func (*Controller) GetRepository ¶ added in v0.40.0

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

func (*Controller) GetRepositoryMetadata ¶ added in v0.104.0

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

func (*Controller) GetRun ¶ added in v0.40.0

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

func (*Controller) GetRunHookOutput ¶ added in v0.40.0

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

func (*Controller) GetSetupState ¶ added in v0.56.0

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

func (*Controller) GetStorageConfig ¶ added in v0.42.0

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

func (*Controller) GetTag ¶ added in v0.40.0

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

func (*Controller) GetUnderlyingProperties ¶ added in v0.40.0

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

func (*Controller) GetUsageReportSummary ¶ added in v1.8.0

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

func (*Controller) GetUser ¶ added in v0.40.0

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

func (*Controller) HardResetBranch ¶ added in v1.8.0

func (c *Controller) HardResetBranch(w http.ResponseWriter, r *http.Request, repository, branch string, params apigen.HardResetBranchParams)

func (*Controller) HeadObject ¶ added in v0.88.0

func (c *Controller) HeadObject(w http.ResponseWriter, r *http.Request, repository, ref string, params apigen.HeadObjectParams)

func (*Controller) HealthCheck ¶ added in v0.40.0

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

func (*Controller) ImportCancel ¶ added in v0.102.0

func (c *Controller) ImportCancel(w http.ResponseWriter, r *http.Request, repository, branch string, params apigen.ImportCancelParams)

func (*Controller) ImportStart ¶ added in v0.102.0

func (c *Controller) ImportStart(w http.ResponseWriter, r *http.Request, body apigen.ImportStartJSONRequestBody, repository, branch string)

func (*Controller) ImportStatus ¶ added in v0.102.0

func (c *Controller) ImportStatus(w http.ResponseWriter, r *http.Request, repository, branch string, params apigen.ImportStatusParams)

func (*Controller) InternalCreateBranchProtectionRule ¶ added in v0.111.0

func (c *Controller) InternalCreateBranchProtectionRule(w http.ResponseWriter, r *http.Request, body apigen.InternalCreateBranchProtectionRuleJSONRequestBody, repository string)

func (*Controller) InternalDeleteBranchProtectionRule ¶ added in v0.111.0

func (c *Controller) InternalDeleteBranchProtectionRule(w http.ResponseWriter, r *http.Request, body apigen.InternalDeleteBranchProtectionRuleJSONRequestBody, repository string)

func (*Controller) InternalDeleteGarbageCollectionRules ¶ added in v0.111.0

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

func (*Controller) InternalGetBranchProtectionRules ¶ added in v0.111.0

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

func (*Controller) InternalGetGarbageCollectionRules ¶ added in v0.111.0

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

func (*Controller) InternalSetGarbageCollectionRules ¶ added in v0.111.0

func (c *Controller) InternalSetGarbageCollectionRules(w http.ResponseWriter, r *http.Request, body apigen.InternalSetGarbageCollectionRulesJSONRequestBody, repository string)

func (*Controller) LinkPhysicalAddress ¶ added in v0.40.0

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

func (*Controller) ListBranches ¶ added in v0.40.0

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

func (*Controller) ListGroupMembers ¶ added in v0.40.0

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

func (*Controller) ListGroupPolicies ¶ added in v0.40.0

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

func (*Controller) ListGroups ¶ added in v0.40.0

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

func (*Controller) ListObjects ¶ added in v0.40.0

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

func (*Controller) ListPolicies ¶ added in v0.40.0

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

func (*Controller) ListRepositories ¶ added in v0.40.0

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

func (*Controller) ListRepositoryRuns ¶ added in v0.40.0

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

func (*Controller) ListRunHooks ¶ added in v0.40.0

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

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

func (*Controller) ListUserCredentials ¶ added in v0.40.0

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

func (*Controller) ListUserExternalPrincipals ¶ added in v1.14.0

func (c *Controller) ListUserExternalPrincipals(w http.ResponseWriter, r *http.Request, userID string, params apigen.ListUserExternalPrincipalsParams)

func (*Controller) ListUserGroups ¶ added in v0.40.0

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

func (*Controller) ListUserPolicies ¶ added in v0.40.0

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

func (*Controller) ListUsers ¶ added in v0.40.0

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

func (*Controller) LogAction ¶

func (c *Controller) LogAction(ctx context.Context, action string, r *http.Request, repository, ref, sourceRef string)

func (*Controller) LogCommits ¶ added in v0.40.0

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

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

func (*Controller) MergeIntoBranch ¶ added in v0.40.0

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

func (*Controller) PostStatsEvents ¶ added in v0.89.0

func (c *Controller) PostStatsEvents(w http.ResponseWriter, r *http.Request, body apigen.PostStatsEventsJSONRequestBody)

func (*Controller) PrepareGarbageCollectionCommits ¶ added in v0.43.0

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

func (*Controller) PrepareGarbageCollectionUncommitted ¶ added in v0.85.0

func (c *Controller) PrepareGarbageCollectionUncommitted(w http.ResponseWriter, r *http.Request, body apigen.PrepareGarbageCollectionUncommittedJSONRequestBody, repository string)

func (*Controller) ResetBranch ¶ added in v0.40.0

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

func (*Controller) RestoreRefs ¶ added in v0.40.0

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

func (*Controller) RestoreStatus ¶ added in v1.3.0

func (c *Controller) RestoreStatus(w http.ResponseWriter, r *http.Request, repository string, params apigen.RestoreStatusParams)

func (*Controller) RestoreSubmit ¶ added in v1.3.0

func (c *Controller) RestoreSubmit(w http.ResponseWriter, r *http.Request, body apigen.RestoreSubmitJSONRequestBody, repository string)

func (*Controller) RevertBranch ¶ added in v0.40.0

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

func (*Controller) SetBranchProtectionRules ¶ added in v0.111.0

func (c *Controller) SetBranchProtectionRules(w http.ResponseWriter, r *http.Request, body apigen.SetBranchProtectionRulesJSONRequestBody, repository string, params apigen.SetBranchProtectionRulesParams)

func (*Controller) SetGCRules ¶ added in v0.111.0

func (c *Controller) SetGCRules(w http.ResponseWriter, r *http.Request, body apigen.SetGCRulesJSONRequestBody, repository string)

func (*Controller) SetGarbageCollectionRulesPreflight ¶ added in v0.102.0

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

func (*Controller) SetGroupACL ¶ added in v0.98.0

func (c *Controller) SetGroupACL(w http.ResponseWriter, r *http.Request, body apigen.SetGroupACLJSONRequestBody, groupID string)

func (*Controller) SetRepositoryMetadata ¶ added in v1.8.0

func (c *Controller) SetRepositoryMetadata(w http.ResponseWriter, r *http.Request, body apigen.SetRepositoryMetadataJSONRequestBody, repository string)

func (*Controller) Setup ¶ added in v0.40.0

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

func (*Controller) SetupCommPrefs ¶ added in v0.87.0

func (c *Controller) SetupCommPrefs(w http.ResponseWriter, r *http.Request, body apigen.SetupCommPrefsJSONRequestBody)

func (*Controller) StageObject ¶ added in v0.40.0

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

func (*Controller) StatObject ¶ added in v0.40.0

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

func (*Controller) StsLogin ¶ added in v1.16.0

func (c *Controller) StsLogin(w http.ResponseWriter, r *http.Request, body apigen.StsLoginJSONRequestBody)

func (*Controller) UpdatePolicy ¶ added in v0.40.0

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

func (*Controller) UploadObject ¶ added in v0.40.0

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

func (*Controller) UploadObjectPreflight ¶ added in v0.102.0

func (c *Controller) UploadObjectPreflight(w http.ResponseWriter, r *http.Request, repository, branch string, params apigen.UploadObjectPreflightParams)

type CookieAuthConfig ¶ added in v0.107.1

type CookieAuthConfig struct {
	ValidateIDTokenClaims   map[string]string
	DefaultInitialGroups    []string
	InitialGroupsClaimName  string
	FriendlyNameClaimName   string
	ExternalUserIDClaimName string
	AuthSource              string
	PersistFriendlyName     bool
}

type InjectSnippetsFS ¶ added in v0.66.0

type InjectSnippetsFS struct {
	fs.FS
	// contains filtered or unexported fields
}

func (*InjectSnippetsFS) Open ¶ added in v0.66.0

func (i *InjectSnippetsFS) Open(name string) (fs.File, error)

type Migrator ¶ added in v0.84.0

type Migrator interface {
	Migrate(ctx context.Context) error
}

type OIDCConfig ¶ added in v0.107.1

type OIDCConfig struct {
	ValidateIDTokenClaims  map[string]string
	DefaultInitialGroups   []string
	InitialGroupsClaimName string
	FriendlyNameClaimName  string
	PersistFriendlyName    bool
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
apigen Package apigen provides generated code for our OpenAPI	Package apigen provides generated code for our OpenAPI
apiutil
helpers Package helpers provide useful wrappers for clients using the lakeFS OpenAPI.	Package helpers provide useful wrappers for clients using the lakeFS OpenAPI.
params

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL