Merge pull request #269 from deanblackborough/master

Fix
costs-to-expect · Jul 29, 2023 · 7c52bc3 · 7c52bc3
2 parents a10ba01 + 9df6060
commit 7c52bc3
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 The complete changelog for the Costs to Expect REST API, our changelog follows the format defined at https://keepachangelog.com/en/1.0.0/
 
+## [v3.14.2] - 2023-07-29
+### Fixed
+- Adjusted the structure of the collection for permitted users, user should be an object.
+
 ## [v3.14.1] - 2023-07-28
 ### Fixed
 - User id not included in the permitted users responses.

diff --git a/app/Transformer/PermittedUser.php b/app/Transformer/PermittedUser.php
@@ -15,9 +15,11 @@ public function format(array $to_transform): void
     {
         $this->transformed = [
             'id' => $this->hash->permittedUser()->encode($to_transform['permitted_user_id']),
-            'user_id' => $this->hash->user()->encode($to_transform['permitted_user_user_id']),
-            'name' => $to_transform['permitted_user_name'],
-            'email' => $to_transform['permitted_user_email'],
+            'user' => [
+                'id' => $this->hash->user()->encode($to_transform['permitted_user_user_id']),
+                'name' => $to_transform['permitted_user_name'],
+                'email' => $to_transform['permitted_user_email']
+            ],
             'created' => $to_transform['permitted_user_created_at']
         ];
     }

diff --git a/config/api/app/version.php b/config/api/app/version.php
@@ -3,9 +3,9 @@
 declare(strict_types=1);
 
 return [
-    'version'=> 'v3.14.1',
+    'version'=> 'v3.14.2',
     'prefix' => 'v3',
-    'release_date' => '2023-07-28',
+    'release_date' => '2023-07-29',
     'changelog' => [
         'api' => '/v3/changelog',
         'markdown' => 'https://github.com/costs-to-expect/api/blob/master/CHANGELOG.md'

diff --git a/public/api/schema/permitted-user.json b/public/api/schema/permitted-user.json
@@ -5,24 +5,32 @@
         "id": {
             "type": "string"
         },
-        "user_id": {
-            "type": "string"
-        },
-        "name": {
-            "type": "string"
-        },
-        "email": {
-            "type": "string"
+        "user": {
+            "type": "object",
+            "properties": {
+                "id": {
+                    "type": "string"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "email": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "id",
+                "name",
+                "email"
+            ]
         },
         "created": {
             "type": "string"
         }
     },
     "required": [
         "id",
-        "user_id",
-        "name",
-        "email",
+        "user",
         "created"
     ]
 }