Fossil SCM

Add docs for /json/settings.

stephan 2023-01-20 00:11 json-settings-command

Commit f302b9bc413b0c5c79f2f713a32a5c1f2d159b0bf208205291cd7dc531a01cd4

Parent c7221a2e8c8cc17…

2 files changed +52 +1

A www/json-api/api-settings.md

+52

		--- a/www/json-api/api-settings.md
		+++ b/www/json-api/api-settings.md
		@@ -0,0 +1,52 @@
	1	+# JSON API: /settings
	2	+([⬑JSON API Index](index.md))
	3	+
	4	+Jump to:
	5	+
	6	+* [Fetch Settings](#get)
	7	+* Set Settings is TODOget)
	8	+* [Set Settings](#set)
	9	+
	10	+---
	11	+
	12	+<a id="get"></a>
	13	+# Fetch Settings
	14	+
	15	+Status: Implemented 20230120
	16	+
	17	+Required permissions: "o"
	18	+
	19	+Request: `/json/settings/get[?version=X]`
	20	+
	21	+Response payload example:
	22	+
	23	+```json
	24	+{
	25	+ "access-log":{
	26	+ "versionable":false,
	27	+ "sensitive":false,
	28	+ "defaultValue":"off",
	29	+ "valueSource":null,
	30	+ "value":null
	31	+ },
	32	+...
	33	+ "binary-glob":{
	34	+ "versionable":true,
	35	+ "sensitive":false,
	36	+ "defaultValue":null,
	37	+ "valueSource":"versioned",
	38	+ "value":".gif\n.ico\n.jpg\n.odp\n.dia\n.pdf\n.png\n.wav..."
	39	+ },
	40	+...
	41	+ "web-browser":{
	42	+ "versionable":false,
	43	+ "sensitive":true,
	44	+ "defaultValue":null,
	45	+ "valueSource":"repo",
	46	+ "value":"firefox"
	47	+ }
	48	+}
	49	+```
	50	+
	51	+Each key in the payload is the name of a fossil-recognized setting,
	52	+modeled as an object. Th

	--- a/www/json-api/api-settings.md
	+++ b/www/json-api/api-settings.md
	@@ -0,0 +1,52 @@
1	# JSON API: /settings
2	([⬑JSON API Index](index.md))
3
4	Jump to:
5
6	* [Fetch Settings](#get)
7	* Set Settings is TODOget)
8	* [Set Settings](#set)
9
10	---
11
12	<a id="get"></a>
13	# Fetch Settings
14
15	Status: Implemented 20230120
16
17	Required permissions: "o"
18
19	Request: `/json/settings/get[?version=X]`
20
21	Response payload example:
22
23	```json
24	{
25	"access-log":{
26	"versionable":false,
27	"sensitive":false,
28	"defaultValue":"off",
29	"valueSource":null,
30	"value":null
31	},
32	...
33	"binary-glob":{
34	"versionable":true,
35	"sensitive":false,
36	"defaultValue":null,
37	"valueSource":"versioned",
38	"value":".gif\n.ico\n.jpg\n.odp\n.dia\n.pdf\n.png\n.wav..."
39	},
40	...
41	"web-browser":{
42	"versionable":false,
43	"sensitive":true,
44	"defaultValue":null,
45	"valueSource":"repo",
46	"value":"firefox"
47	}
48	}
49	```
50
51	Each key in the payload is the name of a fossil-recognized setting,
52	modeled as an object. Th

M www/json-api/index.md

		--- www/json-api/index.md
		+++ www/json-api/index.md
		@@ -28,10 +28,11 @@
28	28	* [Diffs](api-diff.md)
29	29	* [Directory Listing](api-dir.md)
30	30	* [File Info](api-finfo.md)
31	31	* [The Obligatory Misc. Category](api-misc.md)
32	32	* [Repository Stats](api-stat.md)
	33	+* [Settings](api-settings.md)
33	34	* [SQL Query](api-query.md)
34	35	* [Tags](api-tag.md)
35	36	* [Tickets](api-ticket.md)
36	37	* [Timeline](api-timeline.md)
37	38	* [User Management](api-user.md)
38	39

	--- www/json-api/index.md
	+++ www/json-api/index.md
	@@ -28,10 +28,11 @@
28	* [Diffs](api-diff.md)
29	* [Directory Listing](api-dir.md)
30	* [File Info](api-finfo.md)
31	* [The Obligatory Misc. Category](api-misc.md)
32	* [Repository Stats](api-stat.md)

33	* [SQL Query](api-query.md)
34	* [Tags](api-tag.md)
35	* [Tickets](api-ticket.md)
36	* [Timeline](api-timeline.md)
37	* [User Management](api-user.md)
38

	--- www/json-api/index.md
	+++ www/json-api/index.md
	@@ -28,10 +28,11 @@
28	* [Diffs](api-diff.md)
29	* [Directory Listing](api-dir.md)
30	* [File Info](api-finfo.md)
31	* [The Obligatory Misc. Category](api-misc.md)
32	* [Repository Stats](api-stat.md)
33	* [Settings](api-settings.md)
34	* [SQL Query](api-query.md)
35	* [Tags](api-tag.md)
36	* [Tickets](api-ticket.md)
37	* [Timeline](api-timeline.md)
38	* [User Management](api-user.md)
39