Fixed schemas not including XML attributes

Author: snake14

Annotations/AnnotationGenerator.php

@@ -950,17 +950,23 @@ public function convertExampleXmlToObject(string $xml): array
         $root = new \SimpleXMLElement($xml);
 
         $toArray = function (\SimpleXMLElement $node) use (&$toArray) {
-            if (!count($node->children())) {
+            if (!count($node->children()) && !count($node->attributes())) {
                 return trim((string)$node);
             }
-            // Group children by tag name; repeated names become arrays
+
+            // Handle any attributes
             $grouped = [];
+            foreach ($node->attributes() as $attribute) {
+                $grouped['oaXmlAttributes'][] = [$attribute->getName() => (string) $attribute];
+            }
+
+            // Group children by tag name; repeated names become arrays
             foreach ($node->children() as $child) {
                 $name = $child->getName();
                 $grouped[$name][] = $toArray($child);
             }
             return array_map(function ($items) {
-                return (count($items) === 1) ? $items[0] : $items;
+                return (count($items) === 1) ? array_pop($items) : $items;
             }, $grouped);
         };
 
@@ -1014,7 +1020,7 @@ protected function determineResponses(array $rules, string $plugin, string $meth
 
         // If the return type is void, use the generic response type
         if (empty($successArray['ref']) && !empty($returnType) && strval($returnType) === 'void') {
-            $successArray['ref'] = '#/components/responses/GenericSuccessNoBody';
+            $successArray['ref'] = '#/components/responses/GenericSuccess';
         }
 
         // If it's a generic type and there's no custom description, use one of the global generic responses
@@ -1389,6 +1395,7 @@ public function buildPropertyAnnotationFromXmlExample(string $propName, array $v
             sprintf('type="%s",', $type),
         ];
 
+        $hasAttributes = false;
         $childLines = [];
         // Recursively check if any of the children are arrays
         foreach ($values as $key => $value) {
@@ -1397,6 +1404,13 @@ public function buildPropertyAnnotationFromXmlExample(string $propName, array $v
                 continue;
             }
 
+            // Special handling for XML attributes
+            if ($key === 'oaXmlAttributes') {
+                $hasAttributes = true;
+                $childLines[] = $this->buildXmlAttributeSchemaLines($value);
+                continue;
+            }
+
             // Handle nested arrays
             if (!is_string($key)) {
                 if (!is_array(reset($value))) {
@@ -1421,7 +1435,7 @@ public function buildPropertyAnnotationFromXmlExample(string $propName, array $v
 
             // Handle arrays of strings which don't have named properties
             $originalKeys = array_keys($originalValues);
-            if (!is_string(reset($originalKeys)) && !is_string(reset($values))) {
+            if (!is_string(reset($originalKeys)) && !is_string(reset($values)) && !$hasAttributes) {
                 $itemProperties = ['type="string"'];
             }
 
@@ -1431,6 +1445,23 @@ public function buildPropertyAnnotationFromXmlExample(string $propName, array $v
         return ['@OA\Property' => array_merge($propertyLines, $childLines)];
     }
 
+    public function buildXmlAttributeSchemaLines(array $attributes): array
+    {
+        $attributeSchemaLines = [];
+        foreach ($attributes as $index => $attribute) {
+            $key = is_array($attribute) ? array_keys($attribute)[0] : $index;
+            $value = is_array($attribute) ? $attribute[$key] : $attribute;
+            $attributeSchemaLines[] = ['@OA\Property' => [
+                "property=\"$key\",",
+                'type="string",',
+                '@OA\Xml(attribute=true),',
+                "example=\"$value\"",
+            ]];
+        }
+
+        return $attributeSchemaLines;
+    }
+
     /**
      * Take a list of lines and remove the trailing comma from the last line.
      *

Annotations/GlobalApiComponents.php

@@ -59,7 +59,29 @@
  *     additionalProperties=true,
  *     @OA\Property(property="result", type="string", example="success"),
  *     @OA\Property(property="message", type="string", example="ok"),
- *     @OA\Property(property="code", type="integer", example="200")
+ *     @OA\Property(property="code", type="integer", example="200"),
+ *     example={"result":"success","message":"ok"}
+ * )
+ *
+ * @OA\Schema(
+ *     schema="GenericSuccessXml",
+ *     type="object",
+ *     description="Generic Matomo success payload in XML.",
+ *     required={"success"},
+ *     additionalProperties=true,
+ *     @OA\Xml(name="result"),
+ *     @OA\Property(
+ *         property="success",
+ *         type="object",
+ *         @OA\Xml(name="success"),
+ *         @OA\Property(
+ *             property="message",
+ *             type="string",
+ *             @OA\Xml(attribute=true),
+ *             example="ok"
+ *         )
+ *     ),
+ *     example={"success":{"message":"ok"}}
  * )
  *
  * Generic Error object
@@ -160,9 +182,9 @@
  *     response="GenericSuccess",
  *     description="Generic 200 response",
  *     @OA\JsonContent(ref="#/components/schemas/GenericSuccess"),
- *     @OA\XmlContent(ref="#/components/schemas/GenericSuccess"),
- *     @OA\MediaType(mediaType="text/plain", @OA\Schema(type="string"), example="Result: success"),
- *     @OA\MediaType(mediaType="text/html",  @OA\Schema(type="string"), example="success")
+ *     @OA\XmlContent(ref="#/components/schemas/GenericSuccessXml"),
+ *     @OA\MediaType(mediaType="text/plain", @OA\Schema(type="string"), example="Success:ok"),
+ *     @OA\MediaType(mediaType="text/html",  @OA\Schema(type="string"), example="<!-- Success: ok -->")
  * )
  *
  * @OA\Response(

tests/Resources/ExampleResponses/CustomAlerts.deleteAlert.json

@@ -0,0 +1 @@
+{"result":"success","message":"ok"}

tests/Resources/ExampleResponses/CustomAlerts.deleteAlert.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<result>
+    <success message="ok" />
+</result>