Fossil SCM
Changes for the following files: www/json-api/api-checkout.md www/json-api/api-finfo.md www/json-api/api-query.md www/json-api/api-tag.md
Commit
d12511740f825271fae77a34f9bd68e4be5fcecd2c9fb69dfdb75d56d92a5b9d
Parent
27c2c293a3b526e…
4 files changed
+1
-1
+1
-1
+2
-2
+2
-2
+1
-1
| --- www/json-api/api-checkout.md | ||
| +++ www/json-api/api-checkout.md | ||
| @@ -7,11 +7,11 @@ | ||
| 7 | 7 | |
| 8 | 8 | **Required permissions:** n/a (local access only) |
| 9 | 9 | |
| 10 | 10 | **Request:** `/json/status` |
| 11 | 11 | |
| 12 | -This command requires a local checkout and is analog to the "fossil | |
| 12 | +This command requires a local checkout and is the analog to the "fossil | |
| 13 | 13 | status" command. |
| 14 | 14 | |
| 15 | 15 | **Request Options:** currently none. |
| 16 | 16 | |
| 17 | 17 | Payload example: |
| 18 | 18 |
| --- www/json-api/api-checkout.md | |
| +++ www/json-api/api-checkout.md | |
| @@ -7,11 +7,11 @@ | |
| 7 | |
| 8 | **Required permissions:** n/a (local access only) |
| 9 | |
| 10 | **Request:** `/json/status` |
| 11 | |
| 12 | This command requires a local checkout and is analog to the "fossil |
| 13 | status" command. |
| 14 | |
| 15 | **Request Options:** currently none. |
| 16 | |
| 17 | Payload example: |
| 18 |
| --- www/json-api/api-checkout.md | |
| +++ www/json-api/api-checkout.md | |
| @@ -7,11 +7,11 @@ | |
| 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 |
+1
-1
| --- www/json-api/api-finfo.md | ||
| +++ www/json-api/api-finfo.md | ||
| @@ -20,11 +20,11 @@ | ||
| 20 | 20 | as opposed to listing all checkins. If set, neither "before" nor |
| 21 | 21 | "after" have any effect.\ |
| 22 | 22 | CLI mode: `--checkin|-ci` |
| 23 | 23 | - `before=DATETIME` only lists checkins from on or before this time.\ |
| 24 | 24 | CLI mode: `--before|-b` |
| 25 | -- `after=DATETIME` only lists checkins from on or before this time. | |
| 25 | +- `after=DATETIME` only lists checkins from on or after this time. | |
| 26 | 26 | Using this option swaps the sort order, to provide reasonable |
| 27 | 27 | behaviour in conjunction with the limit option.\ |
| 28 | 28 | Only one of "before" and "after" may be specified, and if both are |
| 29 | 29 | specified then which one takes precedence is unspecified.\ |
| 30 | 30 | CLI mode: `--after|-a` |
| 31 | 31 |
| --- www/json-api/api-finfo.md | |
| +++ www/json-api/api-finfo.md | |
| @@ -20,11 +20,11 @@ | |
| 20 | as opposed to listing all checkins. If set, neither "before" nor |
| 21 | "after" have any effect.\ |
| 22 | CLI mode: `--checkin|-ci` |
| 23 | - `before=DATETIME` only lists checkins from on or before this time.\ |
| 24 | CLI mode: `--before|-b` |
| 25 | - `after=DATETIME` only lists checkins from on or before this time. |
| 26 | Using this option swaps the sort order, to provide reasonable |
| 27 | behaviour in conjunction with the limit option.\ |
| 28 | Only one of "before" and "after" may be specified, and if both are |
| 29 | specified then which one takes precedence is unspecified.\ |
| 30 | CLI mode: `--after|-a` |
| 31 |
| --- www/json-api/api-finfo.md | |
| +++ www/json-api/api-finfo.md | |
| @@ -20,11 +20,11 @@ | |
| 20 | as opposed to listing all checkins. If set, neither "before" nor |
| 21 | "after" have any effect.\ |
| 22 | CLI mode: `--checkin|-ci` |
| 23 | - `before=DATETIME` only lists checkins from on or before this time.\ |
| 24 | CLI mode: `--before|-b` |
| 25 | - `after=DATETIME` only lists checkins from on or after this time. |
| 26 | Using this option swaps the sort order, to provide reasonable |
| 27 | behaviour in conjunction with the limit option.\ |
| 28 | Only one of "before" and "after" may be specified, and if both are |
| 29 | specified then which one takes precedence is unspecified.\ |
| 30 | CLI mode: `--after|-a` |
| 31 |
+2
-2
| --- www/json-api/api-query.md | ||
| +++ www/json-api/api-query.md | ||
| @@ -60,11 +60,11 @@ | ||
| 60 | 60 | … |
| 61 | 61 | ] |
| 62 | 62 | } |
| 63 | 63 | ``` |
| 64 | 64 | |
| 65 | -The column names are provided in a separate field is because their order | |
| 65 | +The column names are provided in a separate field because their order | |
| 66 | 66 | is guaranteed to match the order of the query columns, whereas object |
| 67 | 67 | key/value pairs might get reordered (typically sorted by key) when |
| 68 | 68 | travelling through different JSON implementations. In this manner, |
| 69 | 69 | clients can e.g. be sure to render the columns in the proper |
| 70 | 70 | (query-specified) order. |
| @@ -76,10 +76,10 @@ | ||
| 76 | 76 | |
| 77 | 77 | Note the column *names* are never *guaranteed* to be exactly as they |
| 78 | 78 | appear in the SQL *unless* they are qualified with an AS, e.g. `SELECT |
| 79 | 79 | foo AS foo...`. When generating reports which need fixed column names, it |
| 80 | 80 | is highly recommended to use an AS qualifier for every column, even if |
| 81 | -they use the same name as the column. This is the only way to guaranty | |
| 81 | +they use the same name as the column. This is the only way to guarantee | |
| 82 | 82 | that the result column names will be stable. (FYI: that behaviour comes |
| 83 | 83 | from sqlite3, not the JSON bits, and this behaviour *has* been known to |
| 84 | 84 | change between sqlite3 versions (so this is not just an idle threat of |
| 85 | 85 | *potential* future incompatibility).) |
| 86 | 86 |
| --- www/json-api/api-query.md | |
| +++ www/json-api/api-query.md | |
| @@ -60,11 +60,11 @@ | |
| 60 | … |
| 61 | ] |
| 62 | } |
| 63 | ``` |
| 64 | |
| 65 | The column names are provided in a separate field is because their order |
| 66 | is guaranteed to match the order of the query columns, whereas object |
| 67 | key/value pairs might get reordered (typically sorted by key) when |
| 68 | travelling through different JSON implementations. In this manner, |
| 69 | clients can e.g. be sure to render the columns in the proper |
| 70 | (query-specified) order. |
| @@ -76,10 +76,10 @@ | |
| 76 | |
| 77 | Note the column *names* are never *guaranteed* to be exactly as they |
| 78 | appear in the SQL *unless* they are qualified with an AS, e.g. `SELECT |
| 79 | foo AS foo...`. When generating reports which need fixed column names, it |
| 80 | is highly recommended to use an AS qualifier for every column, even if |
| 81 | they use the same name as the column. This is the only way to guaranty |
| 82 | that the result column names will be stable. (FYI: that behaviour comes |
| 83 | from sqlite3, not the JSON bits, and this behaviour *has* been known to |
| 84 | change between sqlite3 versions (so this is not just an idle threat of |
| 85 | *potential* future incompatibility).) |
| 86 |
| --- www/json-api/api-query.md | |
| +++ www/json-api/api-query.md | |
| @@ -60,11 +60,11 @@ | |
| 60 | … |
| 61 | ] |
| 62 | } |
| 63 | ``` |
| 64 | |
| 65 | The column names are provided in a separate field because their order |
| 66 | is guaranteed to match the order of the query columns, whereas object |
| 67 | key/value pairs might get reordered (typically sorted by key) when |
| 68 | travelling through different JSON implementations. In this manner, |
| 69 | clients can e.g. be sure to render the columns in the proper |
| 70 | (query-specified) order. |
| @@ -76,10 +76,10 @@ | |
| 76 | |
| 77 | Note the column *names* are never *guaranteed* to be exactly as they |
| 78 | appear in the SQL *unless* they are qualified with an AS, e.g. `SELECT |
| 79 | foo AS foo...`. When generating reports which need fixed column names, it |
| 80 | is highly recommended to use an AS qualifier for every column, even if |
| 81 | they use the same name as the column. This is the only way to guarantee |
| 82 | that the result column names will be stable. (FYI: that behaviour comes |
| 83 | from sqlite3, not the JSON bits, and this behaviour *has* been known to |
| 84 | change between sqlite3 versions (so this is not just an idle threat of |
| 85 | *potential* future incompatibility).) |
| 86 |
+2
-2
| --- www/json-api/api-tag.md | ||
| +++ www/json-api/api-tag.md | ||
| @@ -98,15 +98,15 @@ | ||
| 98 | 98 | path element. |
| 99 | 99 | - `limit=int` (defalt=0) Limits the number of results (0=no limit). |
| 100 | 100 | Since they are ordered from oldest to newest, the newest N results |
| 101 | 101 | will be returned. |
| 102 | 102 | - `type=string` (default=`*`) Searches only for the given type of |
| 103 | - artifact (using fossil's conventional type naming: ci, e, t, w. | |
| 103 | + artifact (using fossil's conventional type naming: ci, e, t, w.) | |
| 104 | 104 | - `raw=bool` (=false) If enabled, the response is an array of hashes |
| 105 | 105 | of the requested artifact type; otherwise, |
| 106 | 106 | it is an array of higher-level objects. If this is |
| 107 | - true, the "name" property is interpretted as-is. If it is false, the | |
| 107 | + true, the "name" property is interpreted as-is. If it is false, the | |
| 108 | 108 | name is automatically prepended with "sym-" (meaning a branch). |
| 109 | 109 | (FIXME: the current semantics are confusing and hard to remember. |
| 110 | 110 | Re-do them.) |
| 111 | 111 | |
| 112 | 112 | **Response payload example, in RAW mode: (expect this format to change |
| 113 | 113 |
| --- www/json-api/api-tag.md | |
| +++ www/json-api/api-tag.md | |
| @@ -98,15 +98,15 @@ | |
| 98 | path element. |
| 99 | - `limit=int` (defalt=0) Limits the number of results (0=no limit). |
| 100 | Since they are ordered from oldest to newest, the newest N results |
| 101 | will be returned. |
| 102 | - `type=string` (default=`*`) Searches only for the given type of |
| 103 | artifact (using fossil's conventional type naming: ci, e, t, w. |
| 104 | - `raw=bool` (=false) If enabled, the response is an array of hashes |
| 105 | of the requested artifact type; otherwise, |
| 106 | it is an array of higher-level objects. If this is |
| 107 | true, the "name" property is interpretted as-is. If it is false, the |
| 108 | name is automatically prepended with "sym-" (meaning a branch). |
| 109 | (FIXME: the current semantics are confusing and hard to remember. |
| 110 | Re-do them.) |
| 111 | |
| 112 | **Response payload example, in RAW mode: (expect this format to change |
| 113 |
| --- www/json-api/api-tag.md | |
| +++ www/json-api/api-tag.md | |
| @@ -98,15 +98,15 @@ | |
| 98 | path element. |
| 99 | - `limit=int` (defalt=0) Limits the number of results (0=no limit). |
| 100 | Since they are ordered from oldest to newest, the newest N results |
| 101 | will be returned. |
| 102 | - `type=string` (default=`*`) Searches only for the given type of |
| 103 | artifact (using fossil's conventional type naming: ci, e, t, w.) |
| 104 | - `raw=bool` (=false) If enabled, the response is an array of hashes |
| 105 | of the requested artifact type; otherwise, |
| 106 | it is an array of higher-level objects. If this is |
| 107 | true, the "name" property is interpreted as-is. If it is false, the |
| 108 | name is automatically prepended with "sym-" (meaning a branch). |
| 109 | (FIXME: the current semantics are confusing and hard to remember. |
| 110 | Re-do them.) |
| 111 | |
| 112 | **Response payload example, in RAW mode: (expect this format to change |
| 113 |