Fossil SCM
json-api: added a note about the authToken being unnecessary, and maybe problematic, when using the --localauth fossil server option.
Commit
f3d3c589855b6933f9a9bc91aa7c9a6d7a8b1e9ca707b90306e01599118555bf
Parent
946bb7e592b90fa…
1 file changed
+4
| --- www/json-api/conventions.md | ||
| +++ www/json-api/conventions.md | ||
| @@ -73,10 +73,14 @@ | ||
| 73 | 73 | request. Determines what access rights the user has, and any given |
| 74 | 74 | request may require specific rights. In principle this is required |
| 75 | 75 | by any request which needs non-guest privileges, but cookie-aware |
| 76 | 76 | clients do not manually need to track this (it is managed as a |
| 77 | 77 | cookie by the agent/browser). |
| 78 | + - Note that when using a fossil server with the `--localauth` option, | |
| 79 | + the `authToken` should not be used. FIXME: have the JSON API simply ignore | |
| 80 | + the `authToken` for this case, rather than failing if the `authToken` | |
| 81 | + is missing or invalid. | |
| 78 | 82 | - `payload`: Command-specific parameters. Most can optionally come in |
| 79 | 83 | via GET parameters, but those taking complex structures expect them |
| 80 | 84 | to be placed here. |
| 81 | 85 | - `indent`: Optionally specifies indentation for the output. 0=no |
| 82 | 86 | indention. 1=a single TAB character for each level of |
| 83 | 87 |
| --- www/json-api/conventions.md | |
| +++ www/json-api/conventions.md | |
| @@ -73,10 +73,14 @@ | |
| 73 | request. Determines what access rights the user has, and any given |
| 74 | request may require specific rights. In principle this is required |
| 75 | by any request which needs non-guest privileges, but cookie-aware |
| 76 | clients do not manually need to track this (it is managed as a |
| 77 | cookie by the agent/browser). |
| 78 | - `payload`: Command-specific parameters. Most can optionally come in |
| 79 | via GET parameters, but those taking complex structures expect them |
| 80 | to be placed here. |
| 81 | - `indent`: Optionally specifies indentation for the output. 0=no |
| 82 | indention. 1=a single TAB character for each level of |
| 83 |
| --- www/json-api/conventions.md | |
| +++ www/json-api/conventions.md | |
| @@ -73,10 +73,14 @@ | |
| 73 | request. Determines what access rights the user has, and any given |
| 74 | request may require specific rights. In principle this is required |
| 75 | by any request which needs non-guest privileges, but cookie-aware |
| 76 | clients do not manually need to track this (it is managed as a |
| 77 | cookie by the agent/browser). |
| 78 | - Note that when using a fossil server with the `--localauth` option, |
| 79 | the `authToken` should not be used. FIXME: have the JSON API simply ignore |
| 80 | the `authToken` for this case, rather than failing if the `authToken` |
| 81 | is missing or invalid. |
| 82 | - `payload`: Command-specific parameters. Most can optionally come in |
| 83 | via GET parameters, but those taking complex structures expect them |
| 84 | to be placed here. |
| 85 | - `indent`: Optionally specifies indentation for the output. 0=no |
| 86 | indention. 1=a single TAB character for each level of |
| 87 |