discourse/spec/requests/api
Martin Brennan 098ab29d41
FEATURE: Add plugin API to register About stat group (#17442)
This commit introduces a new plugin API to register
a group of stats that will be included in about.json
and also conditionally in the site about UI at /about.

The usage is like this:

```ruby
register_about_stat_group("chat_messages", show_in_ui: true) do
  {
    last_day: 1,
    "7_days" => 10,
    "30_days" => 100,
    count: 1000,
    previous_30_days: 120
  }
end
```

In reality the stats will be generated any way the implementer
chooses within the plugin. The `last_day`, `7_days`, `30_days,` and `count`
keys must be present but apart from that additional stats may be added.
Only those core 4 stat keys will be shown in the UI, but everything will be shown
in about.json.

The stat group name is used to prefix the stats in about.json like so:

```json
"chat_messages_last_day": 2322,
"chat_messages_7_days": 2322,
"chat_messages_30_days": 2322,
"chat_messages_count": 2322,
```

The `show_in_ui` option (default false) is used to determine whether the
group of stats is shown on the site About page in the Site Statistics
table. Some stats may be needed purely for reporting purposes and thus
do not need to be shown in the UI to admins/users. An extension to the Site
serializer, `displayed_about_plugin_stat_groups`, has been added so this
can be inspected on the client-side.
2022-07-15 13:16:00 +10:00
..
schemas FEATURE: Add plugin API to register About stat group (#17442) 2022-07-15 13:16:00 +10:00
shared document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
backups_spec.rb DEV: Fix methods removed in Ruby 3.2 (#15459) 2022-01-05 18:45:08 +01:00
badges_spec.rb DEV: Fix flaky admin badges.json api docs spec (#17210) 2022-06-23 14:32:17 -06:00
categories_spec.rb DEV: Add include_subcategories param to api docs (#14534) 2021-10-06 12:34:03 -06:00
groups_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
invites_spec.rb repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
notifications_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
posts_spec.rb DEV: Fix broken spec due to 213bcde080 (#17009) 2022-06-06 16:37:08 +08:00
private_messages_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
search_spec.rb FIX: Limits for PM and group header search (#16887) 2022-05-24 11:31:24 -04:00
site_spec.rb DEV: Unify way to reset Site.preloaded_category_custom_fields (#17384) 2022-07-14 08:54:31 +08:00
tags_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
topics_spec.rb DEV: Allow params to be passed on topic redirects (#16218) 2022-03-17 19:27:51 -06:00
uploads_spec.rb DEV: Correctly tag heredocs (#16061) 2022-02-28 20:50:55 +01:00
user_badges_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
users_spec.rb FIX: Show suspended by user (#16927) 2022-06-01 14:54:23 +02:00