Added missing required examples and fixed default logic

Author: lachiebol

Annotations/AnnotationGenerator.php

@@ -520,7 +520,9 @@ public function buildParameterAnnotationData(string $methodName, string $paramNa
         $description = $this->normaliseDescriptionText($description);
 
         $default = $paramMetadata['default'] ?? null;
-        if (!is_string($default)) {
+        if ($default === null) {
+            $default = NoDefaultValue::class;
+        } elseif (!is_string($default)) {
             $default = json_encode($default);
         }
 

config/ParameterExamples.php

@@ -4,7 +4,7 @@
     'idSite:int|string|int[]' => 1,
     'period:\'day\'|\'week\'|\'month\'|\'year\'|\'range\'' => 'day',
     'period:"day"|"week"|"month"|"year"|"range"' => 'day',
-    'date:string' => '2026-05-01',
+    'date:string' => 'yesterday',
     'idSite:int|string' => 1,
     'apiModule:string' => 'VisitsSummary',
     'apiAction:string' => 'get',
@@ -146,9 +146,12 @@
     'verificationCode:string' => '123456',
     'delegatedManagement:bool' => true,
     'isEnabled:bool|int|string' => true,
-    'clientId:string' => 'analytics-dashboard',
+    'memberOf:string' => 'cn=matomo-users,ou=groups,dc=example,dc=org',
+    'filter:string' => '(objectClass=person)',
+    'initialIdSite:int' => 1,
+    'clientId:string' => '0123456789abcdef0123456789abcdef',
     'grantTypes:string[]' => ['authorization_code'],
-    'scope:string' => 'read:reports',
+    'scope:string' => 'matomo:read',
     'active:string' => '1',
     'plugin:string' => 'HeatmapSessionRecording',
     'format:string' => 'html',
@@ -167,6 +170,14 @@
         1,
         2,
     ],
+    'sourceIdSites:integer|(integer|array<string>)' => [
+        1,
+        2,
+    ],
+    'sourceIdSites:integer | (integer | array<string>)' => [
+        1,
+        2,
+    ],
     'timezone:string' => 'Pacific/Auckland',
     'currency:string' => 'NZD',
     'period:\'day\'|\'week\'|\'month\'|\'never\'' => 'never',

tests/Unit/AnnotationGeneratorTest.php

@@ -544,6 +544,16 @@ public function getTestDataForBuildParameterAnnotationData(): iterable
             'default' => 'false',
             'example' => '',
         ]];
+        yield 'should not include null as a default value' => ['someParam', [
+            'default' => null,
+        ], [], [
+            'name' => 'someParam',
+            'types' => ['string' => null],
+            'description' => '',
+            'required' => 'false',
+            'default' => 'Piwik\API\NoDefaultValue',
+            'example' => '',
+        ]];
         yield 'should still count empty string as a default value' => ['someParam', [
             'default' => '',
         ], [], [