package
1.5.6
Repository: https://github.com/mkungla/git-lfs.git
Documentation: pkg.go.dev

# Packages

schema provides a testing utility for testing API types against a predefined JSON schema.

# Functions

Batch calls the batch API and returns object results.
BatchOrLegacy calls the Batch API and falls back on the Legacy API This is for simplicity, legacy route is not most optimal (serial) TODO LEGACY API: remove when legacy API removed.
No description provided by the author
CurrentCommitter returns a Committer instance populated with the same credentials as would be used to author a commit.
doApiBatchRequest runs the request to the LFS batch API.
doLegacyApiRequest runs the request to the LFS legacy API.
DoRequest runs a request to the LFS API, without parsing the response body.
TODO LEGACY API: remove when legacy API removed.
Legacy calls the legacy API serially and returns ObjectResources TODO LEGACY API: remove when legacy API removed.
No description provided by the author
NewClient instantiates and returns a new instance of *Client, with the given lifecycle.
NewHttpLifecycle initializes a new instance of the *HttpLifecycle type with a new *http.Client, and the given root (see above).
No description provided by the author
No description provided by the author
TODO LEGACY API: remove when legacy API removed.
VerifyUpload calls the "verify" API link relation on obj if it exists.
WrapHttpResponse returns a wrapped *HttpResponse implementing the Repsonse type by using the given *http.Response.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ErrNoOperationGiven is an error which is returned when no operation is provided in a RequestSchema object.

# Structs

Client exposes the LFS API to callers through a multitude of different services and transport mechanisms.
Committer represents a "First Last <[email protected]>" pair.
Filter represents a single qualifier to apply against a set of locks.
HttpLifecycle serves as the default implementation of the Lifecycle interface for HTTP requests.
HttpResponse is an implementation of the Response interface capable of handling HTTP responses.
No description provided by the author
Lock represents a single lock that against a particular path.
LockList encapsulates a set of Locks.
LockRequest encapsulates the payload sent across the API when a client would like to obtain a lock against a particular path on a given remote.
LockResponse encapsulates the information sent over the API in response to a `LockRequest`.
LockSearchRequest encapsulates the request sent to the server when the client would like a list of locks that match the given criteria.
LockService is an API service which encapsulates the Git LFS Locking API.
No description provided by the author
No description provided by the author
RequestSchema provides a schema from which to generate sendable requests.
UnlockRequest encapsulates the data sent in an API request to remove a lock.
UnlockResponse is the result sent back from the API when asked to remove a lock.

# Interfaces

EndpointSource is an interface which encapsulates the behavior of returning `config.Endpoint`s based on a particular operation.
A Lifecycle represents and encapsulates the behavior on an API request from inception to cleanup.
Response is an interface that represents a response returned as a result of executing an API call.

# Type aliases

No description provided by the author