summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorAdam Niedzielski <adamsunday@gmail.com>2017-04-03 15:17:04 +0200
committerAdam Niedzielski <adamsunday@gmail.com>2017-04-03 15:17:04 +0200
commit9543025e88d3d0fe298e95330b8d38802da50cc6 (patch)
treee96e1a10a4ba6cba5cade8cd959b3894b8e67cd8 /doc/api
parent2faf955c241ce7e99111f8fd0cae2e7ab6167e5a (diff)
downloadgitlab-ce-9543025e88d3d0fe298e95330b8d38802da50cc6.tar.gz
Introduce "polling_interval_multiplier" as application setting
Implement module for setting "Poll-Interval" response header. Return 429 in ETag caching middleware when polling is disabled.
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/settings.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/api/settings.md b/doc/api/settings.md
index ad975e2e325..d99695ca986 100644
--- a/doc/api/settings.md
+++ b/doc/api/settings.md
@@ -48,7 +48,8 @@ Example response:
"koding_url": null,
"plantuml_enabled": false,
"plantuml_url": null,
- "terminal_max_session_time": 0
+ "terminal_max_session_time": 0,
+ "polling_interval_multiplier": 1.0
}
```
@@ -88,6 +89,7 @@ PUT /application/settings
| `plantuml_enabled` | boolean | no | Enable PlantUML integration. Default is `false`. |
| `plantuml_url` | string | yes (if `plantuml_enabled` is `true`) | The PlantUML instance URL for integration. |
| `terminal_max_session_time` | integer | no | Maximum time for web terminal websocket connection (in seconds). Set to 0 for unlimited time. |
+| `polling_interval_multiplier` | decimal | no | Interval multiplier used by endpoints that perform polling. Set to 0 to disable polling. |
```bash
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/application/settings?signup_enabled=false&default_project_visibility=internal
@@ -124,6 +126,7 @@ Example response:
"koding_url": null,
"plantuml_enabled": false,
"plantuml_url": null,
- "terminal_max_session_time": 0
+ "terminal_max_session_time": 0,
+ "polling_interval_multiplier": 1.0
}
```