Postman Collection: Include parameter description for formdata

knuckleswtf · Jun 27, 2022 · 10faa50 · 10faa50
1 parent 9e3d35d
commit 10faa50
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/src/Writing/PostmanCollectionWriter.php b/src/Writing/PostmanCollectionWriter.php
@@ -156,7 +156,9 @@ protected function getBodyData(OutputEndpointData $endpoint): array
         switch ($inputMode) {
             case 'formdata':
             case 'urlencoded':
-                $body[$inputMode] = $this->getFormDataParams($endpoint->cleanBodyParameters);
+                $body[$inputMode] = $this->getFormDataParams(
+                    $endpoint->cleanBodyParameters, null, $endpoint->bodyParameters
+                );
                 foreach ($endpoint->fileParameters as $key => $value) {
                     while (is_array($value)) {
                         $keys = array_keys($value);
@@ -187,18 +189,19 @@ protected function getBodyData(OutputEndpointData $endpoint): array
     /**
      * Format form-data parameters correctly for arrays eg. data[item][index] = value
      */
-    protected function getFormDataParams(array $array, ?string $key = null): array
+    protected function getFormDataParams(array $paramsKeyValue, ?string $key = null, array $paramsFullDetails = []): array
     {
         $body = [];
 
-        foreach ($array as $index => $value) {
+        foreach ($paramsKeyValue as $index => $value) {
             $index = $key ? ($key . '[' . $index . ']') : $index;
 
             if (!is_array($value)) {
                 $body[] = [
                     'key' => $index,
                     'value' => $value,
                     'type' => 'text',
+                    'description' => $paramsFullDetails[$index]->description ?? '',
                 ];
 
                 continue;
@@ -329,8 +332,7 @@ private function getResponses(OutputEndpointData $endpoint): array
             foreach ($response->headers as $header => $value) {
                 $headers[] = [
                     'key' => $header,
-                    // Todo remove array support in future
-                    'value' => is_array($value) ? implode('; ', $value) : $value
+                    'value' => $value
                 ];
             }
 

diff --git a/tests/Fixtures/collection.json b/tests/Fixtures/collection.json
@@ -85,7 +85,8 @@
                 {
                   "key": "name",
                   "value": "cat.jpg",
-                  "type": "text"
+                  "type": "text",
+                  "description": "Name of image."
                 },
                 {
                   "key": "image",