UX improvements, #PG-5232

Annotations/GlobalApiComponents.php

@@ -36,7 +36,7 @@
  *     securityScheme="MatomoToken",
  *     type="http",
  *     scheme="bearer",
- *     description="Matomo API token passed in the Authorization header as a bearer token."
+ *     description="Paste your token generated from Personal > Security. Swagger will send it as a Bearer token."
  * )
  *
  * @OA\Server(

ApiReference.php

@@ -36,11 +36,15 @@ public function getClientSideTranslationKeys(&$translationKeys): void
         $translationKeys[] = 'ApiReference_ReportingApiReference';
         $translationKeys[] = 'ApiReference_ReportingApiSummary';
         $translationKeys[] = 'ApiReference_SwaggerPagePluginEmpty';
+        $translationKeys[] = 'ApiReference_SwaggerPageConnectToken';
         $translationKeys[] = 'ApiReference_SwaggerPageRequestFailed';
+        $translationKeys[] = 'ApiReference_SwaggerPageRemoveToken';
         $translationKeys[] = 'ApiReference_SwaggerPageSpecLoadFailed';
         $translationKeys[] = 'ApiReference_SwaggerPageSpecNotAvailable';
         $translationKeys[] = 'ApiReference_SwaggerPageSearchNoResults';
         $translationKeys[] = 'ApiReference_SwaggerPageSearchPlaceholder';
+        $translationKeys[] = 'ApiReference_SwaggerPageTokenConnected';
+        $translationKeys[] = 'ApiReference_SwaggerPageTokenConnectedHeading';
         $translationKeys[] = 'ApiReference_UserAuthentication';
         $translationKeys[] = 'ApiReference_UserAuthenticationManageTokens';
         $translationKeys[] = 'ApiReference_UserAuthenticationUsingTokenAuth';

lang/en.json

@@ -4,13 +4,17 @@
         "ReportingApiMoreInformation": "More info about the Matomo APIs available in %1$sIntroduction to Matomo API%2$s and the %3$sMatomo API Reference%4$s.",
         "ReportingApiReference": "Reporting API Reference",
         "ReportingApiSummary": "All the data in Matomo is available through simple APIs.",
+        "SwaggerPageConnectToken": "Authenticate with a Matomo API token",
         "SwaggerPagePluginEmpty": "No plugins are configured in the ApiReference whitelist.",
         "SwaggerPageRequestFailed": "The plugin whitelist could not be loaded.",
+        "SwaggerPageRemoveToken": "Remove token",
         "SwaggerPageSearchNoResults": "No plugins match your search.",
         "SwaggerPageSearchPlaceholder": "Search by plugin name",
         "UseTryItOutForLiveResponse": "Example responses require Super User access. Use Try it out to see a live response.",
         "SwaggerPageSpecLoadFailed": "The OpenAPI spec could not be loaded for this plugin.",
         "SwaggerPageSpecNotAvailable": "The OpenAPI spec is not available for this plugin yet. %1$sLearn more%2$s",
+        "SwaggerPageTokenConnected": "Token connected",
+        "SwaggerPageTokenConnectedHeading": "Matomo API token connected",
         "UserAuthentication": "User authentication",
         "UserAuthenticationManageTokens": "You can manage your authentication tokens on your security page.",
         "UserAuthenticationUsingTokenAuth": "If you want to request data within a script, a crontab, etc. you need to add the '%3$s' URL parameter to the API calls for URLs that require authentication."

tests/Resources/SwaggerPage/Bandwidth_openapi_spec_v1.0.0.json

@@ -968,7 +968,7 @@
         "securitySchemes": {
             "MatomoToken": {
                 "type": "http",
-                "description": "Matomo API token passed in the Authorization header as a bearer token.",
+                "description": "Paste your token generated from Personal > Security. Swagger will send it as a Bearer token.",
                 "scheme": "bearer"
             }
         }
@@ -988,4 +988,4 @@
         "description": "Matomo Reporting API developer page",
         "url": "https://developer.matomo.org/api-reference/reporting-api/"
     }
-}
+}