apigen

type ChiServerOptions struct {
	BaseURL     string
	BaseRouter  chi.Router
	Middlewares []MiddlewareFunc
}

type ClaimTokenId struct {

	// Unix Epoch in seconds
	ExpiresAt int64  `json:"expires_at"`
	TokenId   string `json:"token_id"`
}

type ClaimTokenIdJSONBody ClaimTokenId

type ClaimTokenIdJSONRequestBody ClaimTokenIdJSONBody

type Conflict Error

type CreateCredentialsParams struct {
	AccessKey *string `json:"access_key,omitempty"`
	SecretKey *string `json:"secret_key,omitempty"`
}

type CreateGroupJSONBody GroupCreation

type CreateGroupJSONRequestBody CreateGroupJSONBody

type CreatePolicyJSONBody Policy

type CreatePolicyJSONRequestBody CreatePolicyJSONBody

type CreateUserExternalPrincipalParams struct {
	PrincipalId string `json:"principalId"`
}

type CreateUserJSONBody UserCreation

type CreateUserJSONRequestBody CreateUserJSONBody

type Credentials struct {
	AccessKeyId string `json:"access_key_id"`

	// Unix Epoch in seconds
	CreationDate int64 `json:"creation_date"`
}

type CredentialsList struct {

	// The pagination mechanism is used to retrieve a list of items.
	Pagination Pagination    `json:"pagination"`
	Results    []Credentials `json:"results"`
}

type CredentialsWithSecret struct {
	AccessKeyId string `json:"access_key_id"`

	// Unix Epoch in seconds.
	CreationDate    int64  `json:"creation_date"`
	SecretAccessKey string `json:"secret_access_key"`
	UserId          int64  `json:"user_id"`

	// Important - this filed is required instead of the user_id which is deprecated. A unique identifier for the user. In password-based authentication should be the email.
	UserName *string `json:"user_name,omitempty"`
}

type DeleteUserExternalPrincipalParams struct {
	PrincipalId string `json:"principalId"`
}

type Error struct {

	// The error message.
	Message string `json:"message"`
}

type ExternalPrincipal struct {
	Id     string `json:"id"`
	UserId string `json:"user_id"`
}

type ExternalPrincipalList struct {

	// The pagination mechanism is used to retrieve a list of items.
	Pagination Pagination          `json:"pagination"`
	Results    []ExternalPrincipal `json:"results"`
}

type GetExternalPrincipalParams struct {
	PrincipalId string `json:"principalId"`
}

type Group struct {

	// Unix Epoch in seconds.
	CreationDate int64   `json:"creation_date"`
	Description  *string `json:"description,omitempty"`

	// A unique identifier of the group.
	Id *string `json:"id,omitempty"`

	// A unique identifier for the group, represented by a human-readable name.
	Name string `json:"name"`
}

type GroupCreation struct {
	Description *string `json:"description,omitempty"`

	// A unique identifier for the group, represented by a human-readable name.
	Id string `json:"id"`
}

type GroupList struct {

	// The pagination mechanism is used to retrieve a list of items.
	Pagination Pagination `json:"pagination"`
	Results    []Group    `json:"results"`
}

type ListGroupMembersParams struct {

	// Indicates the prefix that all returned items must start with for the purpose of filtering results.
	Prefix *PaginationPrefix `json:"prefix,omitempty"`

	// Indicates the starting point for the returned items. Items must be sorted by a specific parameter, and the response should include only those that come after the "after" value in the sorted list. This is used for pagination, as the next page needs to start from a specific point in the ordered items list.
	After *PaginationAfter `json:"after,omitempty"`

	// Specifies the number of items the server should return. It is used to determine how many results to display.
	Amount *PaginationAmount `json:"amount,omitempty"`
}

type ListGroupPoliciesParams struct {

	// Indicates the prefix that all returned items must start with for the purpose of filtering results.
	Prefix *PaginationPrefix `json:"prefix,omitempty"`

	// Indicates the starting point for the returned items. Items must be sorted by a specific parameter, and the response should include only those that come after the "after" value in the sorted list. This is used for pagination, as the next page needs to start from a specific point in the ordered items list.
	After *PaginationAfter `json:"after,omitempty"`

	// Specifies the number of items the server should return. It is used to determine how many results to display.
	Amount *PaginationAmount `json:"amount,omitempty"`
}

type ListGroupsParams struct {

	// Indicates the prefix that all returned items must start with for the purpose of filtering results.
	Prefix *PaginationPrefix `json:"prefix,omitempty"`

	// Indicates the starting point for the returned items. Items must be sorted by a specific parameter, and the response should include only those that come after the "after" value in the sorted list. This is used for pagination, as the next page needs to start from a specific point in the ordered items list.
	After *PaginationAfter `json:"after,omitempty"`

	// Specifies the number of items the server should return. It is used to determine how many results to display.
	Amount *PaginationAmount `json:"amount,omitempty"`
}

type ListPoliciesParams struct {

	// Indicates the prefix that all returned items must start with for the purpose of filtering results.
	Prefix *PaginationPrefix `json:"prefix,omitempty"`

	// Indicates the starting point for the returned items. Items must be sorted by a specific parameter, and the response should include only those that come after the "after" value in the sorted list. This is used for pagination, as the next page needs to start from a specific point in the ordered items list.
	After *PaginationAfter `json:"after,omitempty"`

	// Specifies the number of items the server should return. It is used to determine how many results to display.
	Amount *PaginationAmount `json:"amount,omitempty"`
}

type ListUserCredentialsParams struct {

	// Indicates the prefix that all returned items must start with for the purpose of filtering results.
	Prefix *PaginationPrefix `json:"prefix,omitempty"`

	// Indicates the starting point for the returned items. Items must be sorted by a specific parameter, and the response should include only those that come after the "after" value in the sorted list. This is used for pagination, as the next page needs to start from a specific point in the ordered items list.
	After *PaginationAfter `json:"after,omitempty"`

	// Specifies the number of items the server should return. It is used to determine how many results to display.
	Amount *PaginationAmount `json:"amount,omitempty"`
}

type ListUserExternalPrincipalsParams struct {

	// Indicates the prefix that all returned items must start with for the purpose of filtering results.
	Prefix *PaginationPrefix `json:"prefix,omitempty"`

	// Indicates the starting point for the returned items. Items must be sorted by a specific parameter, and the response should include only those that come after the "after" value in the sorted list. This is used for pagination, as the next page needs to start from a specific point in the ordered items list.
	After *PaginationAfter `json:"after,omitempty"`

	// Specifies the number of items the server should return. It is used to determine how many results to display.
	Amount *PaginationAmount `json:"amount,omitempty"`
}

type ListUserGroupsParams struct {

	// Indicates the prefix that all returned items must start with for the purpose of filtering results.
	Prefix *PaginationPrefix `json:"prefix,omitempty"`

	// Indicates the starting point for the returned items. Items must be sorted by a specific parameter, and the response should include only those that come after the "after" value in the sorted list. This is used for pagination, as the next page needs to start from a specific point in the ordered items list.
	After *PaginationAfter `json:"after,omitempty"`

	// Specifies the number of items the server should return. It is used to determine how many results to display.
	Amount *PaginationAmount `json:"amount,omitempty"`
}

type ListUserPoliciesParams struct {

	// Indicates the prefix that all returned items must start with for the purpose of filtering results.
	Prefix *PaginationPrefix `json:"prefix,omitempty"`

	// Indicates the starting point for the returned items. Items must be sorted by a specific parameter, and the response should include only those that come after the "after" value in the sorted list. This is used for pagination, as the next page needs to start from a specific point in the ordered items list.
	After *PaginationAfter `json:"after,omitempty"`

	// Specifies the number of items the server should return. It is used to determine how many results to display.
	Amount *PaginationAmount `json:"amount,omitempty"`

	// If true, return all distinct policies attached to the user or any of the groups the user belongs to, otherwise, return only the policies directly attached to the user.
	Effective *bool `json:"effective,omitempty"`
}

type ListUsersParams struct {

	// Indicates the prefix that all returned items must start with for the purpose of filtering results.
	Prefix *PaginationPrefix `json:"prefix,omitempty"`

	// Indicates the starting point for the returned items. Items must be sorted by a specific parameter, and the response should include only those that come after the "after" value in the sorted list. This is used for pagination, as the next page needs to start from a specific point in the ordered items list.
	After *PaginationAfter `json:"after,omitempty"`

	// Specifies the number of items the server should return. It is used to determine how many results to display.
	Amount *PaginationAmount `json:"amount,omitempty"`
	Id     *int64            `json:"id,omitempty"`
	Email  *string           `json:"email,omitempty"`

	// Used only in lakeFS Enterprise; not applicable in the lakeFS OSS version.
	ExternalId *string `json:"external_id,omitempty"`
}

type MiddlewareFunc func(http.HandlerFunc) http.HandlerFunc

type NotFound Error

type Pagination struct {

	// A boolean indicating whether the Next page is available.
	HasMore bool `json:"has_more"`

	// Maximum number of entries per page.
	MaxPerPage int `json:"max_per_page"`

	// A value used to retrieve the next page of results. This value is typically passed as the after parameter in the subsequent API call. The next page will include all items appearing after the specified next_offset.
	NextOffset string `json:"next_offset"`

	// Number of values in the results.
	Results int `json:"results"`
}

type PaginationAfter string

type PaginationAmount int

type PaginationPrefix string

type Policy struct {

	// Represents the access control list assigned to this policy.
	Acl *string `json:"acl,omitempty"`

	// Unix Epoch in seconds.
	CreationDate *int64 `json:"creation_date,omitempty"`

	// A unique, human-readable name for the policy.
	Name      string      `json:"name"`
	Statement []Statement `json:"statement"`
}

type PolicyCondition struct {
	AdditionalProperties map[string][]string `json:"-"`
}

type PolicyList struct {

	// The pagination mechanism is used to retrieve a list of items.
	Pagination Pagination `json:"pagination"`
	Results    []Policy   `json:"results"`
}

type ServerError Error

type ServerInterface interface {
	// get credentials
	// (GET /auth/credentials/{accessKeyId})
	GetCredentials(w http.ResponseWriter, r *http.Request, accessKeyId string)
	// describe external principal by id
	// (GET /auth/external/principals)
	GetExternalPrincipal(w http.ResponseWriter, r *http.Request, params GetExternalPrincipalParams)
	// list groups
	// (GET /auth/groups)
	ListGroups(w http.ResponseWriter, r *http.Request, params ListGroupsParams)
	// create group
	// (POST /auth/groups)
	CreateGroup(w http.ResponseWriter, r *http.Request, body CreateGroupJSONRequestBody)
	// delete group
	// (DELETE /auth/groups/{groupId})
	DeleteGroup(w http.ResponseWriter, r *http.Request, groupId string)
	// get group
	// (GET /auth/groups/{groupId})
	GetGroup(w http.ResponseWriter, r *http.Request, groupId string)
	// list group members
	// (GET /auth/groups/{groupId}/members)
	ListGroupMembers(w http.ResponseWriter, r *http.Request, groupId string, params ListGroupMembersParams)
	// delete group membership
	// (DELETE /auth/groups/{groupId}/members/{userId})
	DeleteGroupMembership(w http.ResponseWriter, r *http.Request, groupId string, userId string)
	// add group membership
	// (PUT /auth/groups/{groupId}/members/{userId})
	AddGroupMembership(w http.ResponseWriter, r *http.Request, groupId string, userId string)
	// list group policies
	// (GET /auth/groups/{groupId}/policies)
	ListGroupPolicies(w http.ResponseWriter, r *http.Request, groupId string, params ListGroupPoliciesParams)
	// detach policy from group
	// (DELETE /auth/groups/{groupId}/policies/{policyId})
	DetachPolicyFromGroup(w http.ResponseWriter, r *http.Request, groupId string, policyId string)
	// attach policy to group
	// (PUT /auth/groups/{groupId}/policies/{policyId})
	AttachPolicyToGroup(w http.ResponseWriter, r *http.Request, groupId string, policyId string)
	// list policies
	// (GET /auth/policies)
	ListPolicies(w http.ResponseWriter, r *http.Request, params ListPoliciesParams)
	// create policy
	// (POST /auth/policies)
	CreatePolicy(w http.ResponseWriter, r *http.Request, body CreatePolicyJSONRequestBody)
	// delete policy
	// (DELETE /auth/policies/{policyId})
	DeletePolicy(w http.ResponseWriter, r *http.Request, policyId string)
	// get policy
	// (GET /auth/policies/{policyId})
	GetPolicy(w http.ResponseWriter, r *http.Request, policyId string)
	// update policy
	// (PUT /auth/policies/{policyId})
	UpdatePolicy(w http.ResponseWriter, r *http.Request, body UpdatePolicyJSONRequestBody, policyId string)
	// claim a token ID, returns validation error if already claimed
	// (POST /auth/tokenid/claim)
	ClaimTokenId(w http.ResponseWriter, r *http.Request, body ClaimTokenIdJSONRequestBody)
	// list users
	// (GET /auth/users)
	ListUsers(w http.ResponseWriter, r *http.Request, params ListUsersParams)
	// create user
	// (POST /auth/users)
	CreateUser(w http.ResponseWriter, r *http.Request, body CreateUserJSONRequestBody)
	// delete user
	// (DELETE /auth/users/{userId})
	DeleteUser(w http.ResponseWriter, r *http.Request, userId string)
	// get user
	// (GET /auth/users/{userId})
	GetUser(w http.ResponseWriter, r *http.Request, userId string)
	// list user credentials
	// (GET /auth/users/{userId}/credentials)
	ListUserCredentials(w http.ResponseWriter, r *http.Request, userId string, params ListUserCredentialsParams)
	// create credentials
	// (POST /auth/users/{userId}/credentials)
	CreateCredentials(w http.ResponseWriter, r *http.Request, userId string, params CreateCredentialsParams)
	// delete credentials
	// (DELETE /auth/users/{userId}/credentials/{accessKeyId})
	DeleteCredentials(w http.ResponseWriter, r *http.Request, userId string, accessKeyId string)
	// get credentials for a user
	// (GET /auth/users/{userId}/credentials/{accessKeyId})
	GetCredentialsForUser(w http.ResponseWriter, r *http.Request, userId string, accessKeyId string)
	// delete external principal from user's external principal list
	// (DELETE /auth/users/{userId}/external/principals)
	DeleteUserExternalPrincipal(w http.ResponseWriter, r *http.Request, userId string, params DeleteUserExternalPrincipalParams)
	// Create principal as external identity connected to a user
	// (POST /auth/users/{userId}/external/principals)
	CreateUserExternalPrincipal(w http.ResponseWriter, r *http.Request, userId string, params CreateUserExternalPrincipalParams)
	// list external principals for user
	// (GET /auth/users/{userId}/external/principals/ls)
	ListUserExternalPrincipals(w http.ResponseWriter, r *http.Request, userId string, params ListUserExternalPrincipalsParams)
	// update users friendly name
	// (PUT /auth/users/{userId}/friendly_name)
	UpdateUserFriendlyName(w http.ResponseWriter, r *http.Request, body UpdateUserFriendlyNameJSONRequestBody, userId string)
	// list user groups
	// (GET /auth/users/{userId}/groups)
	ListUserGroups(w http.ResponseWriter, r *http.Request, userId string, params ListUserGroupsParams)
	// update users password
	// (PUT /auth/users/{userId}/password)
	UpdatePassword(w http.ResponseWriter, r *http.Request, body UpdatePasswordJSONRequestBody, userId string)
	// list user policies
	// (GET /auth/users/{userId}/policies)
	ListUserPolicies(w http.ResponseWriter, r *http.Request, userId string, params ListUserPoliciesParams)
	// detach policy from user
	// (DELETE /auth/users/{userId}/policies/{policyId})
	DetachPolicyFromUser(w http.ResponseWriter, r *http.Request, userId string, policyId string)
	// attach policy to user
	// (PUT /auth/users/{userId}/policies/{policyId})
	AttachPolicyToUser(w http.ResponseWriter, r *http.Request, userId string, policyId string)

	// (GET /config/version)
	GetVersion(w http.ResponseWriter, r *http.Request)

	// (GET /healthcheck)
	HealthCheck(w http.ResponseWriter, r *http.Request)
}

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
}

type Statement struct {
	Action []string `json:"action"`

	// Optional conditions for when this statement applies.
	Condition *Statement_Condition `json:"condition,omitempty"`
	Effect    string               `json:"effect"`
	Resource  string               `json:"resource"`
}

type Statement_Condition struct {
	AdditionalProperties map[string]PolicyCondition `json:"-"`
}

type Unauthorized Error

type UpdatePasswordJSONBody UserPassword

type UpdatePasswordJSONRequestBody UpdatePasswordJSONBody

type UpdatePolicyJSONBody Policy

type UpdatePolicyJSONRequestBody UpdatePolicyJSONBody

type UpdateUserFriendlyNameJSONBody struct {
	FriendlyName string `json:"friendly_name"`
}

type UpdateUserFriendlyNameJSONRequestBody UpdateUserFriendlyNameJSONBody

type User struct {

	// Unix Epoch in seconds.
	CreationDate int64   `json:"creation_date"`
	Email        *string `json:"email,omitempty"`

	// Represents an encrypted password as a string.
	EncryptedPassword []byte  `json:"encryptedPassword"`
	ExternalId        *string `json:"external_id,omitempty"`

	// A name for the user that is not necessarily unique.
	FriendlyName *string `json:"friendly_name,omitempty"`

	// User source. Based on implementation.
	Source *string `json:"source,omitempty"`

	// A unique identifier for the user.
	Username string `json:"username"`
}

type UserCreation struct {

	// If provided, the email is set to the same value as the username.
	Email *string `json:"email,omitempty"`

	// Represents an encrypted password as a string.
	EncryptedPassword *[]byte `json:"encryptedPassword,omitempty"`
	ExternalId        *string `json:"external_id,omitempty"`
	FriendlyName      *string `json:"friendlyName,omitempty"`

	// A boolean that determines whether an invitation email should be sent to a user for account creation. If passed and set to true, the invitation email will be sent along with the user creation.
	Invite *bool `json:"invite,omitempty"`

	// User source. Based on implementation.
	Source *string `json:"source,omitempty"`

	// A unique identifier for the user. For password-based authentication, it is the email.
	Username string `json:"username"`
}

type UserList struct {

	// The pagination mechanism is used to retrieve a list of items.
	Pagination Pagination `json:"pagination"`
	Results    []User     `json:"results"`
}

type UserPassword struct {
	EncryptedPassword []byte `json:"encryptedPassword"`
}

type ValidationError Error

type VersionConfig struct {
	Version string `json:"version"`
}