lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
1b8ddaee78
git-lfs/docs/api
History
David Pursehouse 1b8ddaee78 Lock API doc: Don't use "already created lock" in example 500 error 
If the lock already existed, this would presumably result in a
409 Conflict error, which is already documented with "already
created lock" as the example message.

Change the example message for 500 to "internal server error".

Change-Id: Ic71d6c454e1f049b0b89422f5f2737af5ef36727
Signed-off-by: David Pursehouse <dpursehouse@collab.net>
2017-03-14 16:49:52 +09:00
..
schemas docs: maintain symlinked json schemas 2017-02-13 13:25:37 -07:00
authentication.md separate the server discovery and auth sections to separate docs 2016-11-10 13:32:47 -07:00
basic-transfers.md write up docs on the basic transfer adapter 2016-11-10 14:47:51 -07:00
batch.md docs: Address ttaylorr's comments 2017-02-02 08:47:34 -07:00
locking.md Lock API doc: Don't use "already created lock" in example 500 error 2017-03-14 16:49:52 +09:00
README.md docs: add v1 of the locking api 2017-02-01 16:49:40 -07:00
server-discovery.md separate the server discovery and auth sections to separate docs 2016-11-10 13:32:47 -07: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: