lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
048948b1d4
git-lfs/docs/api
History
brian m. carlson 883cacf9cb
docs/api: document a new batch error code 
In some cases, it may be useful to return an error code if the number of
objects in the batch response is too larger for the server to handle.
Document the 413 error code for this case, since it is in use by at
least one implementation for this purpose.
2019-05-15 21:37:29 +00:00
..
schemas docs: maintain symlinked json schemas 2017-02-13 13:25:37 -07:00
authentication.md docs/api: fix references to expires_in 2017-04-05 16:23:33 -06:00
basic-transfers.md docs/api: fix references to expires_in 2017-04-05 16:23:33 -06:00
batch.md docs/api: document a new batch error code 2019-05-15 21:37:29 +00:00
locking.md Merge pull request #3650 from slonopotamus/patch-1 2019-05-15 21:21:40 +00:00
README.md docs: add v1 of the locking api 2017-02-01 16:49:40 -07:00
server-discovery.md docs/api: add an explicit <br> 2017-04-05 16:23:45 -06:00

README.md

Git LFS API

The Git LFS client uses an HTTPS server to coordinate fetching and storing large binary objects separately from a Git server. The basic process the client goes through looks like this:

  1. Discover the LFS Server to use.
  2. Apply Authentication.
  3. Make the request. See the Batch and File Locking API sections.

Batch API

The Batch API is used to request the ability to transfer LFS objects with the LFS server.

API Specification:

Current transfer adapters include:

Experimental transfer adapters include:

File Locking API

The File Locking API is used to create, list, and delete locks, as well as verify that locks are respected in Git pushes.

API Specification: