Fixing scoping to make spec generation work

Author: snake14

Annotations/GlobalApiComponents.php

@@ -15,7 +15,6 @@
 
 /**
  * @OA\OpenApi(
- *     openapi="3.1.0",
  *     security={{"MatomoToken": {}}},
  *     @OA\ExternalDocumentation(
  *         description="Matomo Reporting API developer page",
@@ -58,7 +57,7 @@
  *     description="Generic Matomo success payload.",
  *     required={"result","message"},
  *     additionalProperties=true,
- *     @OA\Property(property="result", type="string", enum={"success"}, example="success"),
+ *     @OA\Property(property="result", type="string", example="success"),
  *     @OA\Property(property="message", type="string", example="ok"),
  *     @OA\Property(property="code", type="integer", example="200")
  * )
@@ -70,7 +69,7 @@
  *     description="Generic Matomo error payload.",
  *     required={"result","message"},
  *     additionalProperties=true,
- *     @OA\Property(property="result", type="string", enum={"error"}, example="error"),
+ *     @OA\Property(property="result", type="string", example="error"),
  *     @OA\Property(property="message", type="string", example="There was an error"),
  *     @OA\Property(property="code", type="integer")
  * )

Specs/SpecGenerator.php

@@ -82,14 +82,13 @@ public function generateSpec(array $pluginNames, string $format = 'json', string
                 throw new \Exception('There was an error testing the API annotations for plugin ' . $pluginName, 0, $e);
             }
             if (trim($openapi->toYaml()) === 'openapi: ' . OpenApi::DEFAULT_VERSION) {
-                var_dump($openapi->toYaml());
                 throw new \Exception("The $pluginName plugin's API class does not appear to be annotated yet.");
             }
             $pluginDirs[$pluginName] = $pluginAnnotationsSource;
         }
 
         $generator = new Generator(StaticContainer::get(LoggerInterface::class));
-        $openapi = $generator->generate(array_merge([
+        $openapi = $generator->setVersion(OpenApi::VERSION_3_1_0)->generate(array_merge([
             $currentPluginDir . '/Annotations/GlobalApiComponents.php',
         ], $pluginDirs));
 

composer.json

@@ -1,6 +1,7 @@
 {
     "require": {
-        "zircote/swagger-php": "^5.4"
+        "zircote/swagger-php": "^5.4",
+        "doctrine/annotations": "^2.0"
     },
     "replace": {
         "monolog/monolog": "*",

composer.lock

@@ -56,7 +56,26 @@
     'force-no-global-alias' => $forceNoGlobalAlias,
     'prefix' => 'Matomo\\Dependencies\\' . $pluginName,
     'finders' => $finders,
-    'patchers' => [],
+    'patchers' => [
+        // Patcher for making sure that AbstractAnnotation is looking for the correct root
+        static function (string $filePath, string $prefix, string $content) use ($isRenamingReferences): string {
+            if ($isRenamingReferences) {
+                return $content;
+            }
+
+            // Fix the string reference of a scoped dependency in the Math lib
+            $escapedPrefix = str_replace('\\', '\\\\', $prefix);
+            if ($filePath === __DIR__ . '/vendor/zircote/swagger-php/src/Annotations/AbstractAnnotation.php') {
+                $content = str_replace(
+                    'OpenApi\\\\Annotations\\\\',
+                    "{$escapedPrefix}\\\\OpenApi\\\\Annotations\\\\",
+                    $content
+                );
+            }
+
+            return $content;
+        },
+    ],
     'include-namespaces' => $namespacesToIncludeRegexes,
     'exclude-namespaces' => $namespacesToExclude,
     'exclude-constants' => [

scoper.inc.php

@@ -22,4 +22,4 @@
 
 require_once __DIR__ . '/composer/autoload_real.php';
 
-return ComposerAutoloaderInitc8345434bce3699d515e040a2b2da4fa::getLoader();
+return ComposerAutoloaderInitc02410b41ab976b8400bb73dedbf07dc::getLoader();

vendor/autoload_original.php

@@ -9,6 +9,9 @@
     'Symfony\\Polyfill\\Ctype\\' => array($vendorDir . '/symfony/polyfill-ctype'),
     'Symfony\\Component\\Yaml\\' => array($vendorDir . '/symfony/yaml'),
     'Symfony\\Component\\Finder\\' => array($vendorDir . '/symfony/finder'),
+    'Psr\\Cache\\' => array($vendorDir . '/psr/cache/src'),
     'PhpParser\\' => array($vendorDir . '/nikic/php-parser/lib/PhpParser'),
     'OpenApi\\' => array($vendorDir . '/zircote/swagger-php/src'),
+    'Doctrine\\Common\\Lexer\\' => array($vendorDir . '/doctrine/lexer/src'),
+    'Doctrine\\Common\\Annotations\\' => array($vendorDir . '/doctrine/annotations/lib/Doctrine/Common/Annotations'),
 );

vendor/composer/autoload_psr4.php

@@ -2,7 +2,7 @@
 
 // autoload_real.php @generated by Composer
 
-class ComposerAutoloaderInitc8345434bce3699d515e040a2b2da4fa
+class ComposerAutoloaderInitc02410b41ab976b8400bb73dedbf07dc
 {
     private static $loader;
 
@@ -22,16 +22,16 @@ public static function getLoader()
             return self::$loader;
         }
 
-        spl_autoload_register(array('ComposerAutoloaderInitc8345434bce3699d515e040a2b2da4fa', 'loadClassLoader'), true, true);
+        spl_autoload_register(array('ComposerAutoloaderInitc02410b41ab976b8400bb73dedbf07dc', 'loadClassLoader'), true, true);
         self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(__DIR__));
-        spl_autoload_unregister(array('ComposerAutoloaderInitc8345434bce3699d515e040a2b2da4fa', 'loadClassLoader'));
+        spl_autoload_unregister(array('ComposerAutoloaderInitc02410b41ab976b8400bb73dedbf07dc', 'loadClassLoader'));
 
         require __DIR__ . '/autoload_static.php';
-        call_user_func(\Composer\Autoload\ComposerStaticInitc8345434bce3699d515e040a2b2da4fa::getInitializer($loader));
+        call_user_func(\Composer\Autoload\ComposerStaticInitc02410b41ab976b8400bb73dedbf07dc::getInitializer($loader));
 
         $loader->register(true);
 
-        $filesToLoad = \Composer\Autoload\ComposerStaticInitc8345434bce3699d515e040a2b2da4fa::$files;
+        $filesToLoad = \Composer\Autoload\ComposerStaticInitc02410b41ab976b8400bb73dedbf07dc::$files;
         $requireFile = \Closure::bind(static function ($fileIdentifier, $file) {
             if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
                 $GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;