Update API doc

spira · Jul 29, 2015 · bf0f2a7 · bf0f2a7
1 parent 9e6f4d8
commit bf0f2a7
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/api/resources/views/documentation/apiary.blade.apib b/api/resources/views/documentation/apiary.blade.apib
@@ -3,7 +3,7 @@ HOST: {{ $apiUrl }}/
 
 {{-- Inject the model factory so entities be declared with factories --}}
 @inject('factory', 'App\Services\ModelFactory')
-
+@inject('jwtAuth', 'Tymon\JWTAuth\JWTAuth')
 
 # Spira API
 

diff --git a/api/resources/views/documentation/sections/auth.blade.apib b/api/resources/views/documentation/sections/auth.blade.apib
@@ -18,7 +18,7 @@ Auth uses [JSON Web Tokens](http://self-issued.info/docs/draft-ietf-oauth-json-w
 
     + Body
 
-            {!! $factory->json(\App\Models\AuthToken::class) !!}
+            {!! $jwtAuth->decode(new Tymon\JWTAuth\Token($jwtAuth->fromUser($factory->make(\App\Models\User::class)))) !!}
 
 ## Refresh Token [/auth/jwt/refresh]
 *Before* tokens expire they can be renewed with a get request with the current valid token as an `Authorization: Bearer`
@@ -28,11 +28,11 @@ Auth uses [JSON Web Tokens](http://self-issued.info/docs/draft-ietf-oauth-json-w
 + Request
     + Headers
 
-            Authorization: Bearer {!! $factory->make(\App\Models\AuthToken::class)->token !!}
+            Authorization: Bearer {!! $jwtAuth->fromUser($factory->make(\App\Models\User::class)) !!}
 
 + Response 200
 
-            {!! $factory->json(\App\Models\AuthToken::class) !!}
+            {!! $jwtAuth->decode(new Tymon\JWTAuth\Token($jwtAuth->fromUser($factory->make(\App\Models\User::class)))) !!}
 
 ## Token Login [/auth/jwt/token]
 Sometimes a user receives a token in a link by email that is exchanged with an auth token. Tokens are _always_ single
@@ -46,4 +46,4 @@ Sometimes a user receives a token in a link by email that is exchanged with an a
 
 + Response 200
 
-            {!! $factory->json(\App\Models\AuthToken::class) !!}
+            {!! $jwtAuth->decode(new Tymon\JWTAuth\Token($jwtAuth->fromUser($factory->make(\App\Models\User::class)))) !!}
diff --git a/api/resources/views/documentation/sections/user.blade.apib b/api/resources/views/documentation/sections/user.blade.apib
@@ -16,7 +16,7 @@ with a third party through OAuth)
 + Request
     + Headers
 
-            Authorization: Bearer {!! $factory->make(\App\Models\AuthToken::class)->token !!}
+            Authorization: Bearer {!! $jwtAuth->fromUser($factory->make(\App\Models\User::class)) !!}
 
 + Response 200 (application/json)
 
@@ -36,7 +36,7 @@ with a third party through OAuth)
 + Request
     + Headers
 
-            Authorization: Bearer {!! $factory->make(\App\Models\AuthToken::class)->token !!}
+            Authorization: Bearer {!! $jwtAuth->fromUser($factory->make(\App\Models\User::class)) !!}
 
 + Response 200 (application/json)
 
@@ -81,7 +81,7 @@ password credentials - social signin is described later in this document (@todo)
 + Request
     + Headers
 
-            Authorization: Bearer {!! $factory->make(\App\Models\AuthToken::class)->token !!}
+            Authorization: Bearer {!! $jwtAuth->fromUser($factory->make(\App\Models\User::class)) !!}
 
     + Body
 
@@ -103,7 +103,7 @@ email is sent to the user with a reset token.
 + Request
     + Headers
 
-            Authorization: Bearer {!! $factory->make(\App\Models\AuthToken::class)->token !!}
+            Authorization: Bearer {!! $jwtAuth->fromUser($factory->make(\App\Models\User::class)) !!}
 
 + Response 202
 
@@ -114,6 +114,6 @@ email is sent to the user with a reset token.
 + Request
     + Headers
 
-            Authorization: Bearer {!! $factory->make(\App\Models\AuthToken::class)->token !!}
+            Authorization: Bearer {!! $jwtAuth->fromUser($factory->make(\App\Models\User::class)) !!}
 
 + Response 204