diff options
| author | jejacks0n <jjackson@gitlab.com> | 2019-08-12 15:10:07 -0600 |
|---|---|---|
| committer | jejacks0n <jjackson@gitlab.com> | 2019-08-13 14:14:59 -0600 |
| commit | 9a16b2822baed669ef0b98cd392fd5b8c1f5bca2 (patch) | |
| tree | 9d466689628927f0d68de892be863fd79b160c0c | |
| parent | 6c3380b1c5f71e69a15ed149bc7ffd28cf5f984f (diff) | |
| download | gitlab-ce-9a16b2822baed669ef0b98cd392fd5b8c1f5bca2.tar.gz | |
Adds snowplow api options to documentation
| -rw-r--r-- | doc/api/settings.md | 4 | ||||
| -rw-r--r-- | lib/api/settings.rb | 8 |
2 files changed, 8 insertions, 4 deletions
diff --git a/doc/api/settings.md b/doc/api/settings.md index 83125aff264..248d19461f6 100644 --- a/doc/api/settings.md +++ b/doc/api/settings.md @@ -321,4 +321,8 @@ are listed in the descriptions of the relevant settings. | `user_show_add_ssh_key_message` | boolean | no | When set to `false` disable the "You won't be able to pull or push project code via SSH" warning shown to users with no uploaded SSH key. | | `version_check_enabled` | boolean | no | Let GitLab inform you when an update is available. | | `local_markdown_version` | integer | no | Increase this value when any cached markdown should be invalidated. | +| `snowplow_enabled` | boolean | no | Enable snowplow tracking. | +| `snowplow_collector_hostname` | string | required by: `snowplow_enabled` | The Snowplow collector hostname. (e.g. `snowplow.trx.gitlab.net`) | +| `snowplow_site_id` | string | no | The Snowplow site name / application id. (e.g. `gitlab`) | +| `snowplow_cookie_domain` | string | no | The Snowplow cookie domain. (e.g. `.gitlab.com`) | | `geo_node_allowed_ips` | string | yes | **(PREMIUM)** Comma-separated list of IPs and CIDRs of allowed secondary nodes. For example, `1.1.1.1, 2.2.2.0/24`. | diff --git a/lib/api/settings.rb b/lib/api/settings.rb index 9ca79aa0ecb..c36ee5af63f 100644 --- a/lib/api/settings.rb +++ b/lib/api/settings.rb @@ -125,11 +125,11 @@ module API optional :instance_statistics_visibility_private, type: Boolean, desc: 'When set to `true` Instance statistics will only be available to admins' optional :local_markdown_version, type: Integer, desc: "Local markdown version, increase this value when any cached markdown should be invalidated" optional :allow_local_requests_from_hooks_and_services, type: Boolean, desc: 'Deprecated: Use :allow_local_requests_from_web_hooks_and_services instead. Allow requests to the local network from hooks and services.' # support legacy names, can be removed in v5 - optional :snowplow_enabled, type: Grape::API::Boolean, desc: 'Enable Snowplow Tracking' + optional :snowplow_enabled, type: Grape::API::Boolean, desc: 'Enable Snowplow tracking' given snowplow_enabled: ->(val) { val } do - requires :snowplow_collector_hostname, type: String, desc: 'Snowplow Collector URI' - optional :snowplow_cookie_domain, type: String, desc: 'Snowplow cookie domain' - optional :snowplow_site_id, type: String, desc: 'Snowplow Site/Application ID' + requires :snowplow_collector_hostname, type: String, desc: 'The Snowplow collector hostname' + optional :snowplow_cookie_domain, type: String, desc: 'The Snowplow cookie domain' + optional :snowplow_site_id, type: String, desc: 'The Snowplow site name / application ic' end ApplicationSetting::SUPPORTED_KEY_TYPES.each do |type| |