Class: Admin::Config::SiteSettingsController

Inherits:
AdminController
  • Object
show all
Defined in:
app/controllers/admin/config/site_settings_controller.rb

Constant Summary collapse

ADMIN_CONFIG_AREA_ALLOWLISTED_HIDDEN_SETTINGS =
%i[
  extended_site_description
  about_banner_image
  community_owner
]

Instance Method Summary collapse

Instance Method Details

#indexObject

This endpoint is intended to be used only for admin config areas, for a specific collection of site settings. The admin site settings UI itself uses the Admin::SiteSettingsController#index endpoint, which also supports a ‘category` and `plugin` filter.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# File 'app/controllers/admin/config/site_settings_controller.rb', line 14

def index
  if params[:plugin].blank? && params[:categories].blank? && params[:filter_names].blank? &&
       SiteSetting.valid_areas.exclude?(params[:filter_area])
    raise Discourse::InvalidParameters
  end

  render_json_dump(
    site_settings:
      SiteSetting.all_settings(
        filter_names: params[:filter_names],
        filter_area: params[:filter_area],
        filter_plugin: params[:plugin],
        filter_categories: Array.wrap(params[:categories]),
        include_locale_setting: false,
        include_hidden: true,
        filter_allowed_hidden: ADMIN_CONFIG_AREA_ALLOWLISTED_HIDDEN_SETTINGS,
      ),
  )
end