Skip to content

API.md

Latest commit

 

History

History
455 lines (434 loc) · 11.7 KB

API.md

File metadata and controls

455 lines (434 loc) · 11.7 KB
Raw

BucketGit Exported Go API

Generated by go run ./tools/api_inventory. This is the public BucketGit Go SDK v1 compatibility surface.

github.com/bucketgit/bgit/protocol

  • const CIBuilding
  • const CIFinished
  • const CIQueued
  • const HeaderKey
  • const HeaderKeyFingerprint
  • const HeaderNonce
  • const HeaderSignature
  • const HeaderSignatureMessage
  • const HeaderSignatureVersion
  • const HeaderSignedHost
  • const HeaderTimestamp
  • const LaneBacklog
  • const LaneDoing
  • const LaneDone
  • const LaneReady
  • const LaneReview
  • const OperationDelete
  • const OperationMerge
  • const OperationRead
  • const OperationWrite
  • const ProviderFile
  • const ProviderGCS
  • const ProviderS3
  • const PullRequestClosed
  • const PullRequestMerged
  • const PullRequestOpen
  • const RoleAdmin
  • const RoleDeveloper
  • const RoleMaintainer
  • const RoleOwner
  • const RoleRead
  • const RoleTriage
  • const SignaturePrefix
  • const SignatureVersion
  • func SignatureMessage
  • func ValidateRequestMetadata
  • method BrokerError.Error
  • method BrokerError.Unwrap
  • method Repository.Validate
  • method Role.Valid
  • type AWSCredentials
  • type AdminRepositoryInfoResponse
  • type AuthRequest
  • type AuthResponse
  • type AuthStatus
  • type AuthStatusRequest
  • type BrokerError
  • type CILogResponse
  • type CIRequest
  • type CIRun
  • type CIStatus
  • type Identity
  • type Issue
  • type IssueEvent
  • type IssueReply
  • type IssueRequest
  • type Key
  • type KeyRequest
  • type KeysResponse
  • type Lane
  • type ObjectCapabilityRequest
  • type ObjectCapabilityResponse
  • type ObjectRequest
  • type ObjectResponse
  • type Operation
  • type OwnerRequest
  • type OwnerTransferRequest
  • type OwnerTransferResponse
  • type Protection
  • type Provider
  • type PullRequest
  • type PullRequestComment
  • type PullRequestNote
  • type PullRequestRequest
  • type PullRequestResponse
  • type PullRequestStatus
  • type PullRequestsResponse
  • type RefUpdateRequest
  • type RefsRequest
  • type RefsResponse
  • type RepositoriesMineResponse
  • type Repository
  • type RepositoryAdminRequest
  • type RepositoryInfo
  • type RepositoryInfoRequest
  • type RepositoryInfoResponse
  • type RepositoryInvite
  • type RepositoryInvitesResponse
  • type RepositoryListResponse
  • type RepositoryMembership
  • type RepositoryRequest
  • type RepositoryTeamGrant
  • type RepositoryTeamsResponse
  • type RepositoryUserGrant
  • type RepositoryUsersResponse
  • type RequestMetadata
  • type Role
  • type Team
  • type TeamMember
  • type TeamsResponse
  • type UserInfo
  • type UserProfile
  • type UserProfileKey
  • type UserProfileRequest
  • type UserProfileResponse
  • type UsersResponse
  • var ErrConflict
  • var ErrReplay
  • var ErrSignatureExpired
  • var ErrUnauthorized
  • var ErrUnsupported

github.com/bucketgit/bgit/store

  • func IsZeroOID
  • func ReadRefs
  • func ValidSHA1
  • func ValidatePath
  • func ValidateRefUpdate
  • method FallbackReader.List
  • method FallbackReader.Read
  • type CompareAndSwapper
  • type FallbackReader
  • type ObjectState
  • type Reader
  • type RefStore
  • type Writer
  • var ErrConflict
  • var ErrInvalidPath
  • var ErrNotFound
  • var ErrNotSupported
  • var ErrReadOnly

github.com/bucketgit/bgit/store/fs

  • func New
  • method Store.CompareAndSwap
  • method Store.CompareAndSwapRef
  • method Store.Delete
  • method Store.List
  • method Store.ListRefs
  • method Store.Read
  • method Store.Write
  • type Store

github.com/bucketgit/bgit/store/s3

  • func Load
  • func New
  • method Store.CompareAndSwap
  • method Store.CompareAndSwapRef
  • method Store.Delete
  • method Store.List
  • method Store.ListRefs
  • method Store.Read
  • method Store.Write
  • type API
  • type Options
  • type Store

github.com/bucketgit/bgit/store/gcs

  • func Load
  • func New
  • func NewWithAPI
  • method Store.Close
  • method Store.CompareAndSwap
  • method Store.CompareAndSwapRef
  • method Store.Delete
  • method Store.List
  • method Store.ListRefs
  • method Store.Read
  • method Store.Write
  • type API
  • type ObjectAttrs
  • type Options
  • type Store

github.com/bucketgit/bgit/repository

  • const Added
  • const BlobObject
  • const CommitObject
  • const DefaultMaxObjectSize
  • const Deleted
  • const Modified
  • const TagObject
  • const TreeObject
  • func Open
  • func ParseCommitData
  • func ParseOID
  • func WithMaxObjectSize
  • func WithObjectVerification
  • method OID.String
  • method Repository.ArchiveTar
  • method Repository.Commit
  • method Repository.Diff
  • method Repository.IsAncestor
  • method Repository.ListRefs
  • method Repository.MergeBase
  • method Repository.Object
  • method Repository.ReachableObjects
  • method Repository.Resolve
  • method Repository.Snapshot
  • method Repository.Tree
  • method Repository.TreeEntries
  • type Change
  • type ChangeStatus
  • type Commit
  • type File
  • type OID
  • type Object
  • type ObjectType
  • type Option
  • type Repository
  • type Signature
  • type TreeEntry

github.com/bucketgit/bgit/broker/client

  • func New
  • func NewEndpoints
  • func NewV2Signatures
  • func RandomNonce
  • method Client.AuthStatus
  • method Client.Authorize
  • method Client.ListCIRuns
  • method Client.ListIssues
  • method Client.ListPullRequests
  • method Client.ListRefs
  • method Client.ObjectCapability
  • method Client.PostJSON
  • method Client.PostJSONBytes
  • method Client.UpdateRef
  • method Endpoints.AcceptBrokerUserInvite
  • method Endpoints.AcceptOwnerTransfer
  • method Endpoints.AcceptRepositoryInvite
  • method Endpoints.AddKey
  • method Endpoints.ArchiveIssue
  • method Endpoints.AssignIssue
  • method Endpoints.AuthStatus
  • method Endpoints.Authorize
  • method Endpoints.CILogs
  • method Endpoints.CancelBrokerUserInvite
  • method Endpoints.CancelOwnerTransfer
  • method Endpoints.CancelRepositoryInvite
  • method Endpoints.CloseIssue
  • method Endpoints.ClosePullRequest
  • method Endpoints.CommentIssue
  • method Endpoints.CommentPullRequest
  • method Endpoints.ConfirmOwnerTransfer
  • method Endpoints.CreateBrokerUserInvite
  • method Endpoints.CreateIssue
  • method Endpoints.CreatePullRequest
  • method Endpoints.CreateRepository
  • method Endpoints.CreateRepositoryInvite
  • method Endpoints.CreateTeam
  • method Endpoints.DeleteRepository
  • method Endpoints.DeleteTeam
  • method Endpoints.DeleteUser
  • method Endpoints.GetCIRun
  • method Endpoints.GetIssue
  • method Endpoints.GetPullRequest
  • method Endpoints.GetRepository
  • method Endpoints.GetUserProfile
  • method Endpoints.IssueAssignees
  • method Endpoints.ListCIRuns
  • method Endpoints.ListIssues
  • method Endpoints.ListKeys
  • method Endpoints.ListProtections
  • method Endpoints.ListPullRequests
  • method Endpoints.ListRefs
  • method Endpoints.ListRepositories
  • method Endpoints.ListRepositoryInvites
  • method Endpoints.ListRepositoryTeams
  • method Endpoints.ListRepositoryUsers
  • method Endpoints.ListTeams
  • method Endpoints.ListUsers
  • method Endpoints.MergePullRequest
  • method Endpoints.MoveIssue
  • method Endpoints.ObjectCapability
  • method Endpoints.ReindexRepositoryMembers
  • method Endpoints.RemoveKey
  • method Endpoints.RemoveProtection
  • method Endpoints.RemoveRepositoryTeam
  • method Endpoints.RemoveRepositoryUser
  • method Endpoints.RemoveTeamMember
  • method Endpoints.RenameRepository
  • method Endpoints.ReopenIssue
  • method Endpoints.ReopenPullRequest
  • method Endpoints.ReorderIssue
  • method Endpoints.ReplyPullRequest
  • method Endpoints.RepositoryInfo
  • method Endpoints.ResolveTeam
  • method Endpoints.ReviewPullRequest
  • method Endpoints.RotateCISecret
  • method Endpoints.RunCI
  • method Endpoints.SuspendKey
  • method Endpoints.SyncPullRequests
  • method Endpoints.TakeIssue
  • method Endpoints.UpdateIssue
  • method Endpoints.UpdateRef
  • method Endpoints.UpdateRepository
  • method Endpoints.UpdateUserProfile
  • method Endpoints.UpsertProtection
  • method Endpoints.UpsertRepositoryTeam
  • method Endpoints.UpsertRepositoryUser
  • method Endpoints.UpsertTeamMember
  • method Endpoints.UpsertUser
  • method SignatureProviderFunc.HeaderSets
  • method V2Signatures.HeaderSets
  • type Caller
  • type Client
  • type Endpoints
  • type ErrorDecoder
  • type NonceSource
  • type Options
  • type RetryPredicate
  • type SignatureProvider
  • type SignatureProviderFunc
  • type SuccessObserver
  • type V2SignatureOptions
  • type V2Signatures

github.com/bucketgit/bgit/broker/capability

  • func New
  • method Store.CompareAndSwapRef
  • method Store.Delete
  • method Store.List
  • method Store.ListRefs
  • method Store.Read
  • method Store.Write
  • type Broker
  • type ErrorClassifier
  • type LocalHandler
  • type Options
  • type Store

github.com/bucketgit/bgit/broker/local

  • const TargetLogicalAlias
  • const TargetStorageExplicit
  • const TargetStorageShorthand
  • func IsZeroOID
  • func New
  • func ParseTarget
  • method Broker.ArchiveIssue
  • method Broker.AssignIssue
  • method Broker.Authorize
  • method Broker.BucketDir
  • method Broker.CommentIssue
  • method Broker.CompareAndSwapJSON
  • method Broker.CreateIssue
  • method Broker.CreateRepository
  • method Broker.DeleteObject
  • method Broker.FindRepository
  • method Broker.GetIssue
  • method Broker.GetRepository
  • method Broker.Handler
  • method Broker.ListIssues
  • method Broker.ListObjects
  • method Broker.ListRepositories
  • method Broker.LoadJSON
  • method Broker.LoadJSONState
  • method Broker.LoadOwners
  • method Broker.LoadRepositoryIndex
  • method Broker.LoadRepositoryState
  • method Broker.LockRepository
  • method Broker.MoveStory
  • method Broker.MoveStoryToLaneEnd
  • method Broker.ObjectPath
  • method Broker.ObjectRoot
  • method Broker.ReadObject
  • method Broker.ReconcileRepository
  • method Broker.Repository
  • method Broker.Root
  • method Broker.SaveJSON
  • method Broker.SaveRepositoryState
  • method Broker.SetIssueClosed
  • method Broker.TakeStory
  • method Broker.UpdateIssue
  • method Broker.UpdateRef
  • method Broker.UpsertOwners
  • method Broker.UpsertRepository
  • method Broker.WriteObject
  • method IdentityVerifierFunc.Verify
  • method RepositoryStore.CompareAndSwap
  • method RepositoryStore.CompareAndSwapRef
  • method RepositoryStore.Delete
  • method RepositoryStore.List
  • method RepositoryStore.ListRefs
  • method RepositoryStore.Read
  • method RepositoryStore.Write
  • method ResolverFunc.Resolve
  • method Target.Provider
  • type Broker
  • type IdentityVerifier
  • type IdentityVerifierFunc
  • type IssueFilter
  • type Options
  • type Owners
  • type RepositoryIndex
  • type RepositoryState
  • type RepositoryStore
  • type Resolver
  • type ResolverFunc
  • type StoryMove
  • type Target
  • type TargetKind

github.com/bucketgit/bgit/transport

  • const DataPacket
  • const DefaultMaxReceivePackSize
  • const DelimiterPacket
  • const FlushPacket
  • const MaxPayload
  • const ReceivePackService
  • const ResponseEndPacket
  • const UploadPackService
  • func EncodePack
  • func ReadPacket
  • func ReadReceivePackRequest
  • func ReadUploadPackRequest
  • func ReceivePackCapabilities
  • func RemoteHelperAddress
  • func ServeReceivePack
  • func ServeRemoteHelper
  • func ServeUploadPack
  • func UploadPackCapabilities
  • func WriteAdvertisedRefs
  • func WriteDelimiter
  • func WriteFlush
  • func WritePacket
  • func WriteResponseEnd
  • func WriteSideband
  • func WriteString
  • method Capabilities.String
  • method ResolverFunc.Serve
  • type Capabilities
  • type Packet
  • type PacketKind
  • type ReceiveCommand
  • type ReceiveRequest
  • type ReceiveStore
  • type Resolver
  • type ResolverFunc
  • type UploadPackRequest