|
1
|
# JSON API: /status |
|
2
|
([⬑JSON API Index](index.md)) |
|
3
|
|
|
4
|
# Status of Local Checkout |
|
5
|
|
|
6
|
**Status:** implemented 20130223 |
|
7
|
|
|
8
|
**Required permissions:** n/a (local access only) |
|
9
|
|
|
10
|
**Request:** `/json/status` |
|
11
|
|
|
12
|
This command requires a local checkout and is the analog to the "fossil |
|
13
|
status" command. |
|
14
|
|
|
15
|
**Request Options:** currently none. |
|
16
|
|
|
17
|
Payload example: |
|
18
|
|
|
19
|
```json |
|
20
|
{ |
|
21
|
"repository":"/home/stephan/cvs/fossil/fossil.fsl", |
|
22
|
"localRoot":"/home/stephan/cvs/fossil/fossil/", |
|
23
|
"checkout":{ |
|
24
|
"uuid":"b38bb4f9bd27d0347b62ecfac63c4b8f57b5c93b", |
|
25
|
"tags":["trunk"], |
|
26
|
"datetime":"2013-02-22 17:34:19 UTC", |
|
27
|
"timestamp":1361554459 |
|
28
|
}, |
|
29
|
/* "parent" info is currently missing. */ |
|
30
|
"files":[ |
|
31
|
{"name":"src/checkin.c", "status":"edited"} |
|
32
|
...], |
|
33
|
"errorCount":0 /* see notes below */ |
|
34
|
} |
|
35
|
``` |
|
36
|
|
|
37
|
Notes: |
|
38
|
|
|
39
|
- The `checkout.tags` property follows the framework-wide convention |
|
40
|
that the first tag in the list is the primary branch and any others |
|
41
|
are secondary. |
|
42
|
- `errorCount` is +1 for each missing file. Conflicts are not treated as |
|
43
|
errors because the CLI 'status' command does not treat them as such. |
|
44
|
- The `"status"` entry for each of the `"files"` entries will be either a |
|
45
|
single string containing a single description of the status change, or |
|
46
|
an array of strings if more than one change was made, e.g. `"edited"` |
|
47
|
and `"renamed"`. The status strings include:\ |
|
48
|
`deleted`, `new`, `notAFile`, `missing`, `updatedByMerge`, |
|
49
|
`updatedByIntegrate`, `addedBymerge`, `addedByIntegrate`, |
|
50
|
`conflict`, `edited`, `renamed` |
|
51
|
- File objects with a `"renamed"` status will contain a `"priorName"` |
|
52
|
property in addition to the `"name"` property reported in all cases. |
|
53
|
- TODO: Info for the parent version is currently missing. |
|
54
|
- TODO: "merged with" info for the checkout is currently missing. |
|
55
|
|