lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
cfb6c0be4f
git-lfs/docs/api
History
Martin Goyot 913c7ed2d3
Fix parameter name on List Locks API Documentation 
On locks listing, the git-lfs client is not querying the `ref` parameter but the `refspec` one. Fix the documentation accordingly.

For reference: 84f47a430b/locking/api.go (156-L157)
2019-01-15 11:27:59 +01: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 refspec docs 2018-01-17 11:54:08 -07:00
locking.md Fix parameter name on List Locks API Documentation 2019-01-15 11:27:59 +01: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: