API Settings and Doc need some clean up work
I noticed some funny spacing in /doc/api/settings.md (both CE and EE), and while cleaning it up I slowly started to find more and more problems. I will use this issue to try to keep track of the problems I find, as well as my questions. I will track changes I make in MRs. I will add ~"docs:P3" ~P3 labels for now, but could potentially be higher.
I will admit right away that this is clearly more work than I expected (I started off just wanting to fix spacing!), and it's mostly new to me so I don't understand how to know which settings can be changed by api calls. I'm hoping someone can point me in the right way so I can check these settings myself!
Also, I'll split the MRs below into two: One MR for Doc changes, one MR for code changes, in each of CE and EE.
CE Changes so far: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/20571
EE Changes so far: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6473
-
help_page_text
setting seems to be missing from CE api Settings Doc (EE Too). -
shared_runners_text
andterminal_max_session_time
missing from EE api Settings Doc -
usage_ping_enabled
andrepository_storages
are listed as EE Only in EE Api Settings, but are listed as NOT EE Only in CE Api Settings. Which is correct? -
These settings are in ee/app/helpers/ee/application_settings_helper.rb, but not in the EE Api Settings Doc. How do I check if they are modifiable by api calls, and thus should be added to the Docs? external_authorization_service_timeout
mirror_max_capacity
mirror_max_delay
mirror_capacity_threshold
check_namespace_plan
pseudonymizer_enabled
-
Need to research the following settings in app/helpers/application_settings_helper.rb, that are not present in EE api Settings Doc. How do I check if they are modifiable by api calls, and thus should be added to the Docs? -
allow_local_requests_from_hooks_and_services
-
auto_devops_enabled
-
auto_devops_domain
-
domain_blacklist_raw
-> No, I think? -
domain_whitelist_raw
-> No, I think? -
gitaly_timeout_default
-
gitaly_timeout_medium
-
gitaly_timeout_fast
-
hashed_storage_enabled
-
help_page_text
-
hide_third_party_offers
-
mirror_available
-
pages_domain_verification_enabled
-
throttle_unauthenticated_enabled
-
throttle_unauthenticated_requests_per_period
-
throttle_unauthenticated_period_in_seconds
-
throttle_authenticated_web_enabled
-
throttle_authenticated_web_requests_per_period
-
throttle_authenticated_web_period_in_seconds
-
throttle_authenticated_api_enabled
-
throttle_authenticated_api_requests_per_period
-
throttle_authenticated_api_period_in_seconds
-
-
Need to research the following settings in lib/api/settings.rb. The first two are listed as Can be removed in v5
, and are not present in the Docs. Should they be added to the Docs and listed as Deprecated? In contrast, the last two are listed asCan be removed in v6
, but ARE in the Docs and listed as Deprecated. Should they be removed from the Docs instead?-
password_authentication_enabled
desc: 'Flag indicating if password authentication is enabled for the web interface' # support legacy names, can be removed in v5. -
signin_enabled
desc: 'Flag indicating if password authentication is enabled for the web interface' # support legacy names, can be removed in v5. -
performance_bar_enabled
desc: 'Deprecated: Passperformance_bar_allowed_group_path: nil
instead. Allow enabling the performance.' # support legacy names, can be removed in v6 -
performance_bar_allowed_group_id
desc: 'Deprecated: Use:performance_bar_allowed_group_path
instead. Path of the group that is allowed to toggle the performance bar.' # support legacy names, can be removed in v6
Also, these are present here (as well as above), but not in the Docs.
-
:gitaly_timeout_default, desc: 'Default Gitaly timeout, in seconds. Set to 0 to disable timeouts.'
-
:gitaly_timeout_medium, desc: 'Medium Gitaly timeout, in seconds. Set to 0 to disable timeouts.'
-
:gitaly_timeout_fast, desc: 'Gitaly fast operation timeout, in seconds. Set to 0 to disable timeouts.'
-
Other things already fixed in MR:
File: app/helpers/application_settings_helper.rb
- Order settings alphabetically (CE/EE)
File: lib/api/settings.rb
Fix typos:
-
:sidekiq_throttling_queus
-> queues (CE/EE) -
:performance_bar_allowed_group_id, type: String, desc: 'Depreated:
-> Deprecated (CE/EE)
File: doc/api/settings.md
- Large Cleanup of table spacing, to make .md easier to read, and to make future updates simpler.(CE/EE)
- Order settings alphabetically (CE/EE)
- add missing
help_page_text
setting (CE/EE) -
shared_runners_text
andterminal_max_session_time
were hidden (table formatting broken) by accident in https://gitlab.com/gitlab-org/gitlab-ee/commit/cdca89df96851cbf93c5203a96a4d3d5af316690 (EE Only)