Rerouted menu item, added old api reference url to page, renamed to API instead of Swagger API

Author: lachiebol

ApiReference.php

@@ -29,11 +29,12 @@ public function registerEvents()
 
     public function getClientSideTranslationKeys(&$translationKeys): void
     {
+        $translationKeys[] = 'General_API';
         $translationKeys[] = 'CoreHome_LearnMoreFullStop';
+        $translationKeys[] = 'ApiReference_LookingForLegacyApiReference';
         $translationKeys[] = 'ApiReference_ReportingApiMoreInformation';
         $translationKeys[] = 'ApiReference_ReportingApiReference';
         $translationKeys[] = 'ApiReference_ReportingApiSummary';
-        $translationKeys[] = 'ApiReference_SwaggerApi';
         $translationKeys[] = 'ApiReference_SwaggerPagePluginEmpty';
         $translationKeys[] = 'ApiReference_SwaggerPageRequestFailed';
         $translationKeys[] = 'ApiReference_SwaggerPageSpecLoadFailed';

Menu.php

@@ -20,10 +20,10 @@ public function configureAdminMenu(MenuAdmin $menu): void
             return;
         }
 
-        $menu->addPlatformItem(
-            'ApiReference_SwaggerApi',
-            $this->urlForAction('swagger'),
-            30
+        $menu->editUrl(
+            'CorePluginsAdmin_MenuPlatform',
+            'General_API',
+            $this->urlForAction('swagger')
         );
     }
 }

lang/en.json

@@ -1,9 +1,9 @@
 {
     "ApiReference": {
+        "LookingForLegacyApiReference": "Looking for the legacy API reference? The %1$slegacy API reference%2$s page is still available while we continue improving the new API documentation. If anything is missing or behaving unexpectedly in this new version, %3$splease let us know%4$s so we can improve the experience.",
         "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.",
-        "SwaggerApi": "Swagger API",
         "SwaggerPagePluginEmpty": "No plugins are configured in the ApiReference whitelist.",
         "SwaggerPageRequestFailed": "The plugin whitelist could not be loaded.",
         "SwaggerPageSpecLoadFailed": "The OpenAPI spec could not be loaded for this plugin.",

templates/swagger.twig

@@ -7,7 +7,7 @@
     <script src="plugins/ApiReference/vue/lib/swagger-ui/swagger-ui-bundle.js"></script>
 {% endblock %}
 
-{% set title %}{{ 'ApiReference_SwaggerApi'|translate }}{% endset %}
+{% set title %}{{ 'General_API'|translate }}{% endset %}
 
 {% block content %}
     <div

tests/Integration/MenuTest.php

@@ -50,7 +50,7 @@ public function tearDown(): void
         parent::tearDown();
     }
 
-    public function testConfigureAdminMenuAddsSwaggerItemForViewAccess(): void
+    public function testConfigureAdminMenuAddsApiItemForViewAccess(): void
     {
         FakeAccess::clearAccess(
             $superUser = false,
@@ -62,10 +62,10 @@ public function testConfigureAdminMenuAddsSwaggerItemForViewAccess(): void
         $items = $this->buildConfiguredMenu()->getMenu();
 
         $this->assertArrayHasKey('CorePluginsAdmin_MenuPlatform', $items);
-        $this->assertArrayHasKey('ApiReference_SwaggerApi', $items['CorePluginsAdmin_MenuPlatform']);
+        $this->assertArrayHasKey('General_API', $items['CorePluginsAdmin_MenuPlatform']);
     }
 
-    public function testConfigureAdminMenuSkipsSwaggerItemWithoutViewAccess(): void
+    public function testConfigureAdminMenuSkipsApiItemWithoutViewAccess(): void
     {
         FakeAccess::clearAccess(
             $superUser = false,
@@ -81,7 +81,7 @@ public function testConfigureAdminMenuSkipsSwaggerItemWithoutViewAccess(): void
             return;
         }
 
-        $this->assertArrayNotHasKey('ApiReference_SwaggerApi', $items['CorePluginsAdmin_MenuPlatform']);
+        $this->assertArrayNotHasKey('General_API', $items['CorePluginsAdmin_MenuPlatform']);
     }
 
     private function buildConfiguredMenu(): MenuAdmin