feat(userReports): remove done_storage_limits_check from API response DEV-1268 (#6461)

### 📣 Summary
Remove `extra_details.data.done_storage_limits_check` from
`/api/v2/user-reports/` response. This field is useless for the report.

Author: rajpatel24

jsapp/js/api/models/userReportsListResponseExtraDetailsData.ts

@@ -19,5 +19,4 @@ export type UserReportsListResponseExtraDetailsData = {
   organization_type?: string
   organization_website?: string
   newsletter_subscription?: boolean
-  done_storage_limits_check?: boolean
 }

jsapp/js/api/react-query/server-logs-superusers.ts

@@ -955,7 +955,6 @@ Supports exact matching and range operators (e.g., gte, lte)
 - sso_is_active
 - accepted_tos
 - extra_details__data__newsletter_subscription
-- extra_details__data__done_storage_limits_check
 - service_usage__balances__*metric*__exceeded (metric: submission, asr_seconds, mt_characters, storage_bytes)
 - account_restricted
 

kobo/apps/user_reports/migrations/0002_create_user_reports_mv.py

@@ -146,7 +146,11 @@
             ELSE NULL
         END AS organization,
         jsonb_build_object(
-            'data', ued.data::jsonb,
+            'data',
+                CASE
+                    WHEN ued.data IS NULL THEN NULL
+                    ELSE (ued.data::jsonb - 'done_storage_limits_check')
+                END,
             'date_removed',
                 CASE
                     WHEN ued.date_removed IS NOT NULL

kpi/docs/api/v2/user_reports/list.md

@@ -72,7 +72,6 @@ Supports exact matching and range operators (e.g., gte, lte)
 - sso_is_active
 - accepted_tos
 - extra_details__data__newsletter_subscription
-- extra_details__data__done_storage_limits_check
 - service_usage__balances__*metric*__exceeded (metric: submission, asr_seconds, mt_characters, storage_bytes)
 - account_restricted
 

kpi/schema_extensions/v2/user_reports/extensions.py

@@ -28,9 +28,6 @@ def map_serializer_field(self, auto_schema, direction):
                         'organization_type': GENERIC_STRING_SCHEMA,
                         'organization_website': GENERIC_STRING_SCHEMA,
                         'newsletter_subscription': build_basic_type(OpenApiTypes.BOOL),
-                        'done_storage_limits_check': build_basic_type(
-                            OpenApiTypes.BOOL
-                        ),
                     }
                 ),
                 'date_removed': build_basic_type(OpenApiTypes.DATETIME),

static/openapi/schema_v2.json

@@ -11647,7 +11647,7 @@
         "/api/v2/user-reports/": {
             "get": {
                 "operationId": "api_v2_user_reports_list",
-                "description": "# List user reports\n\n⚠️ _Only available to superusers_\n\n## Filterable fields by string:\n\nSupports partial filtering\n- username\n- first_name\n- last_name\n- email\n- user_uid\n- organization__name\n- organization__role (e.g., admin, member, owner)\n- organization__website\n- extra_details__data__organization_type\n- `extra_details__data__<field>` (other string fields, e.g., name, sector, country...)\n\n## Filterable fields by int:\n\nSupports exact matching and range operators (e.g., gte, lte)\n\n**Total NLP Usage**\n- service_usage__total_nlp_usage__asr_seconds_all_time\n- service_usage__total_nlp_usage__mt_characters_all_time\n- service_usage__total_nlp_usage__asr_seconds_current_period\n- service_usage__total_nlp_usage__mt_characters_current_period\n\n**Total Storage/Submissions**\n- service_usage__total_storage_bytes\n- service_usage__total_submission_count__all_time\n- service_usage__total_submission_count__current_period\n\n**Service Usage Balances**\n\nPrefix: `service_usage__balances__<metric>__<value>`\n\nMetric:\n- submission\n- asr_seconds\n- mt_characters\n- storage_bytes\n\nValue:\n- balance_value\n- balance_percent\n- effective_limit\n\nEx: `service_usage__balances__submission__balance_value`\n\n**Asset Count**\n- asset_count\n- deployed_asset_count\n\n## Filterable fields by date:\nSupports exact matching and range operators (e.g., gte, lte)\n\n- date_joined\n- last_login\n- extra_details__date_removal_requested\n- extra_details__date_removed\n- extra_details_password_date_changed\n\n## Filterable fields by boolean:\n\n- is_superuser\n- is_staff\n- is_active\n- validated_email\n- extra_details__validated_password\n- mfa_is_active\n- sso_is_active\n- accepted_tos\n- extra_details__data__newsletter_subscription\n- extra_details__data__done_storage_limits_check\n- service_usage__balances__*metric*__exceeded (metric: submission, asr_seconds, mt_characters, storage_bytes)\n- account_restricted\n\n## Filterable fields by list:\n\nSubscription filtering:\n\nHas subscriptions\n\n`?q=subscriptions__0__id__isnull:False`\n\nNo subscriptions\n\n`?q=subscriptions__0__id__isnull:True`\n\nSubscription id\n\n`?q=subscriptions[]__id:sub_1QwPItAR39rDI89stzLJ040p`\n\nActive subscriptions\n\n`?q=subscriptions[]__status:active`\n",
+                "description": "# List user reports\n\n⚠️ _Only available to superusers_\n\n## Filterable fields by string:\n\nSupports partial filtering\n- username\n- first_name\n- last_name\n- email\n- user_uid\n- organization__name\n- organization__role (e.g., admin, member, owner)\n- organization__website\n- extra_details__data__organization_type\n- `extra_details__data__<field>` (other string fields, e.g., name, sector, country...)\n\n## Filterable fields by int:\n\nSupports exact matching and range operators (e.g., gte, lte)\n\n**Total NLP Usage**\n- service_usage__total_nlp_usage__asr_seconds_all_time\n- service_usage__total_nlp_usage__mt_characters_all_time\n- service_usage__total_nlp_usage__asr_seconds_current_period\n- service_usage__total_nlp_usage__mt_characters_current_period\n\n**Total Storage/Submissions**\n- service_usage__total_storage_bytes\n- service_usage__total_submission_count__all_time\n- service_usage__total_submission_count__current_period\n\n**Service Usage Balances**\n\nPrefix: `service_usage__balances__<metric>__<value>`\n\nMetric:\n- submission\n- asr_seconds\n- mt_characters\n- storage_bytes\n\nValue:\n- balance_value\n- balance_percent\n- effective_limit\n\nEx: `service_usage__balances__submission__balance_value`\n\n**Asset Count**\n- asset_count\n- deployed_asset_count\n\n## Filterable fields by date:\nSupports exact matching and range operators (e.g., gte, lte)\n\n- date_joined\n- last_login\n- extra_details__date_removal_requested\n- extra_details__date_removed\n- extra_details_password_date_changed\n\n## Filterable fields by boolean:\n\n- is_superuser\n- is_staff\n- is_active\n- validated_email\n- extra_details__validated_password\n- mfa_is_active\n- sso_is_active\n- accepted_tos\n- extra_details__data__newsletter_subscription\n- service_usage__balances__*metric*__exceeded (metric: submission, asr_seconds, mt_characters, storage_bytes)\n- account_restricted\n\n## Filterable fields by list:\n\nSubscription filtering:\n\nHas subscriptions\n\n`?q=subscriptions__0__id__isnull:False`\n\nNo subscriptions\n\n`?q=subscriptions__0__id__isnull:True`\n\nSubscription id\n\n`?q=subscriptions[]__id:sub_1QwPItAR39rDI89stzLJ040p`\n\nActive subscriptions\n\n`?q=subscriptions[]__status:active`\n",
                 "parameters": [
                     {
                         "name": "limit",
@@ -20345,9 +20345,6 @@
                                     },
                                     "newsletter_subscription": {
                                         "type": "boolean"
-                                    },
-                                    "done_storage_limits_check": {
-                                        "type": "boolean"
                                     }
                                 }
                             },

static/openapi/schema_v2.yaml

@@ -8499,7 +8499,6 @@ paths:
         - sso_is_active
         - accepted_tos
         - extra_details__data__newsletter_subscription
-        - extra_details__data__done_storage_limits_check
         - service_usage__balances__*metric*__exceeded (metric: submission, asr_seconds, mt_characters, storage_bytes)
         - account_restricted
 
@@ -14787,8 +14786,6 @@ components:
                   type: string
                 newsletter_subscription:
                   type: boolean
-                done_storage_limits_check:
-                  type: boolean
             date_removed:
               type: string
               format: date-time