Updates API doc

spira · Jul 26, 2015 · 3f38be9 · 3f38be9
1 parent 51f8d59
commit 3f38be9
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/api/resources/views/documentation/sections/user.blade.apib b/api/resources/views/documentation/sections/user.blade.apib
@@ -75,13 +75,20 @@ password credentials - social signin is described later in this document (@todo)
 + Response 204
 
 ### Update user entity [PATCH]
+
+When the user changes their email an mail will be sent to the new address with a
+token in it. Then when a PATCH request is issued to the column `email_confirmed`
+the `Email-Confirm-Token: <token>` header must be set with the token from before
+or the request will be rejected.
+
 #### Restrictions
 * Allowed - [admin, self]
 
 + Request
     + Headers
 
             Authorization: Bearer {!! $factory->make(\App\Models\AuthToken::class)->token !!}
+            Email-Confirm-Token: {!! hash_hmac('sha256', str_random(40), str_random(40)); !!}
 
     + Body