Plugin cleanup, #PG-5170 (#44)

* Fix swagger code block styling

* Updated php version requirements and added learn more FAQ for missing specs

* implement auto scroll behaviour to keep opened plugin in view

* added php version 7.4 support

* add hash param for learn more

* updated version to 7.4 for tests

* Updated vue

* Update FAQ url

* removed todo comment

* eslint fixes and vue build

* update tests to have max variable

Author: lachiebol

.github/workflows/matomo-tests.yml

@@ -1,7 +1,7 @@
 # Action for running tests
 # This file has been automatically created.
 # To recreate it you can run this command
-# ./console generate:test-action --plugin="ApiReference" --php-versions="7.2,8.4" --schedule-cron="0 19 * * 6"
+# ./console generate:test-action --plugin="ApiReference" --php-versions="7.4,8.4" --schedule-cron="0 19 * * 6"
 
 name: Plugin ApiReference Tests
 
@@ -37,7 +37,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: [ '7.2', '8.4' ]
+        php: [ '7.4', 'matomo5_max_php' ]
         target: ['minimum_required_matomo', 'maximum_supported_matomo']
     steps:
       - uses: actions/checkout@v3
@@ -55,4 +55,4 @@ jobs:
           matomo-test-branch: ${{ matrix.target }}
           redis-service: true
           artifacts-pass: ${{ secrets.ARTIFACTS_PASS }}
-          upload-artifacts: ${{ matrix.php == '7.2' && matrix.target == 'maximum_supported_matomo' }}
+          upload-artifacts: ${{ matrix.php == '7.4' && matrix.target == 'maximum_supported_matomo' }}

ApiReference.php

@@ -37,6 +37,7 @@ public function getClientSideTranslationKeys(&$translationKeys): void
         $translationKeys[] = 'ApiReference_SwaggerPagePluginEmpty';
         $translationKeys[] = 'ApiReference_SwaggerPageRequestFailed';
         $translationKeys[] = 'ApiReference_SwaggerPageSpecLoadFailed';
+        $translationKeys[] = 'ApiReference_SwaggerPageSpecNotAvailable';
         $translationKeys[] = 'ApiReference_SwaggerPageSearchNoResults';
         $translationKeys[] = 'ApiReference_SwaggerPageSearchPlaceholder';
         $translationKeys[] = 'ApiReference_UserAuthentication';

lang/en.json

@@ -6,9 +6,10 @@
         "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.",
         "SwaggerPageSearchNoResults": "No plugins match your search.",
         "SwaggerPageSearchPlaceholder": "Search by plugin name",
+        "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",
         "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."

plugin.json

@@ -13,6 +13,7 @@
     "license": "GPL v3+",
     "homepage": "https:\/\/matomo.org",
     "require": {
+        "php": ">=7.4.0",
         "matomo": ">=5.0.0-stable,<6.0.0-b1"
     },
     "authors": [