lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs/custom-transfers: Format JSON consistently

Browse Source 
Signed-off-by: Steffen Prohaska <prohaska@zib.de>
This commit is contained in:
Steffen Prohaska 2017-04-23 10:31:09 +02:00
parent aef5375990
commit c91e8b1580
No known key found for this signature in database
GPG Key ID: CD4EF2ED1339052C
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/custom-transfers.md
View File

@ -104,7 +104,7 @@ the configuration.
The message will look like this: The message will look like this:
```json ```json
{ "event":"init", "operation":"download", "concurrent": true, "concurrenttransfers": 3 } { "event": "init", "operation": "download", "concurrent": true, "concurrenttransfers": 3 }
``` ```
* `event`: Always `init` to identify this message * `event`: Always `init` to identify this message
@ -142,7 +142,7 @@ For uploads the request sent from git-lfs to the transfer process will look
like this: like this:
```json ```json
{ "event":"upload", "oid": "bf3e3e2af9366a3b704ae0c31de5afa64193ebabffde2091936ad2e7510bc03a", "size": 346232, "path": "/path/to/file.png", "action": { "href": "nfs://server/path", "header": { "key": "value" } } } { "event": "upload", "oid": "bf3e3e2af9366a3b704ae0c31de5afa64193ebabffde2091936ad2e7510bc03a", "size": 346232, "path": "/path/to/file.png", "action": { "href": "nfs://server/path", "header": { "key": "value" } } }
``` ```
* `event`: Always `upload` to identify this message * `event`: Always `upload` to identify this message
@ -160,7 +160,7 @@ The transfer process should post one or more [progress messages](#progress) and
then a final completion message as follows: then a final completion message as follows:
```json ```json
{ "event":"complete", "oid": "bf3e3e2af9366a3b704ae0c31de5afa64193ebabffde2091936ad2e7510bc03a"} { "event": "complete", "oid": "bf3e3e2af9366a3b704ae0c31de5afa64193ebabffde2091936ad2e7510bc03a" }
``` ```
* `event`: Always `complete` to identify this message * `event`: Always `complete` to identify this message
@ -169,7 +169,7 @@ then a final completion message as follows:
Or if there was an error in the transfer: Or if there was an error in the transfer:
```json ```json
{ "event":"complete", "oid": "bf3e3e2af9366a3b704ae0c31de5afa64193ebabffde2091936ad2e7510bc03a", "error": { "code": 2, "message": "Explain what happened to this transfer" }} { "event": "complete", "oid": "bf3e3e2af9366a3b704ae0c31de5afa64193ebabffde2091936ad2e7510bc03a", "error": { "code": 2, "message": "Explain what happened to this transfer" } }
``` ```
* `event`: Always `complete` to identify this message * `event`: Always `complete` to identify this message
@ -182,7 +182,7 @@ For downloads the request sent from git-lfs to the transfer process will look
like this: like this:
```json ```json
{ "event":"download", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "size": 21245, "action": { "href": "nfs://server/path", "header": { "key": "value" } } } { "event": "download", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "size": 21245, "action": { "href": "nfs://server/path", "header": { "key": "value" } } }
``` ```
* `event`: Always `download` to identify this message * `event`: Always `download` to identify this message
@ -203,7 +203,7 @@ The transfer process should post one or more [progress messages](#progress) and
then a final completion message as follows: then a final completion message as follows:
```json ```json
{ "event":"complete", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "path": "/path/to/file.png"} { "event": "complete", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "path": "/path/to/file.png" }
``` ```
* `event`: Always `complete` to identify this message * `event`: Always `complete` to identify this message
@ -215,7 +215,7 @@ then a final completion message as follows:
Or, if there was a failure transferring this item: Or, if there was a failure transferring this item:
```json ```json
{ "event":"complete", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "error": { "code": 2, "message": "Explain what happened to this transfer" }} { "event": "complete", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "error": { "code": 2, "message": "Explain what happened to this transfer" } }
``` ```
* `event`: Always `complete` to identify this message * `event`: Always `complete` to identify this message
@ -236,7 +236,7 @@ the transfer process should post messages to stdout as follows before sending
the final completion message: the final completion message:
```json ```json
{ "event":"progress", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "bytesSoFar": 1234, "bytesSinceLast": 64 } { "event": "progress", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "bytesSoFar": 1234, "bytesSinceLast": 64 }
``` ```
* `event`: Always `progress` to identify this message * `event`: Always `progress` to identify this message
@ -254,7 +254,7 @@ When all transfers have been processed, git-lfs will send the following message
to the stdin of the transfer process: to the stdin of the transfer process:
```json ```json
{ "event":"terminate" } { "event": "terminate" }
``` ```
On receiving this message the transfer process should clean up and terminate. On receiving this message the transfer process should clean up and terminate.