Add auth

Author: shalvah

.scribe/.filehashes

@@ -1,4 +1,4 @@
 # GENERATED. YOU SHOULDN'T MODIFY OR DELETE THIS FILE.
 # Scribe uses this file to know when you change something manually in your docs.
 .scribe/index.md=c8cb5fa262a4e2884e5c37d0ebead040
-.scribe/authentication.md=325963d01b9a982f33c1f72830d5786d
+.scribe/authentication.md=aba097a14dadf1ec2bf55a1b7f74376a

.scribe/append.md

@@ -0,0 +1,5 @@
+# Some extra info
+
+Just some extra info added via an `append.md` file.
+
+Go on, [go check Scribe out](https://github.com/knuckleswtf/scribe) 😄.

.scribe/authentication.md

@@ -1,3 +1,7 @@
 # Authenticating requests
 
-This API is not authenticated.
+To authenticate requests, include an **`Authorization`** header with the value **`"Bearer {YOUR_AUTH_KEY}"`**.
+
+All authenticated endpoints are marked with a `requires authentication` badge in the documentation below.
+
+You can retrieve your token by using the `users/auth` endpoint.

.scribe/endpoints.cache/1.yaml

@@ -49,6 +49,7 @@ endpoints:
         from the controller's code. Check out the source! </aside>
       authenticated: true
     headers:
+      Authorization: 'Bearer {YOUR_AUTH_KEY}'
       Content-Type: application/json
       Accept: application/json
     urlParameters: []
@@ -76,7 +77,7 @@ endpoints:
         name: due_at
         description: 'Due date for the side project. Must be a valid date. Must be a valid date in the format <code>Ymd</code>. Must be a date after <code>today</code>.'
         required: false
-        example: '2077-09-25'
+        example: '2077-09-26'
         type: string
     responses: []
     responseFields: []
@@ -107,7 +108,7 @@ endpoints:
     responses:
       -
         status: 200
-        content: '{"data":{"name":"quo quo molestias","description":"Tempora aspernatur officiis omnis sed similique et et.","due_date":"20241229","owner":{"id":1,"name":"Pete","email":"[email protected]","email_verified_at":null,"created_at":"2021-05-29T22:53:05.000000Z","updated_at":"2021-05-29T22:53:05.000000Z"}}}'
+        content: '{"data":{"name":"quo quo molestias","description":"Tempora aspernatur officiis omnis sed similique et et.","due_date":"20241230","owner":{"id":1,"name":"Pete","email":"[email protected]","email_verified_at":null,"created_at":"2021-05-29T22:53:05.000000Z","updated_at":"2021-05-29T22:53:05.000000Z"}}}'
         headers: []
         description: null
     responseFields: []

.scribe/endpoints.cache/2.yaml

@@ -62,7 +62,7 @@ endpoints:
     responses:
       -
         status: 200
-        content: '{"data":{"id":6,"name":"Dr. Kallie Schroeder","email":"[email protected]","side_projects":[{"id":10,"name":"similique et et","description":"Odit molestiae non est nostrum sunt.","url":null,"due_at":"20221027","created_at":"2021-06-01T16:38:10.000000Z","updated_at":"2021-06-01T16:38:10.000000Z","user_id":"6"}]}}'
+        content: '{"data":{"id":6,"name":"Dr. Kallie Schroeder","email":"[email protected]","side_projects":[{"id":10,"name":"similique et et","description":"Odit molestiae non est nostrum sunt.","url":null,"due_at":"20221027","created_at":"2021-06-02T12:17:43.000000Z","updated_at":"2021-06-02T12:17:43.000000Z","user_id":"6"}]}}'
         headers: []
         description: null
       -

.scribe/endpoints/1.yaml

@@ -47,6 +47,7 @@ endpoints:
         from the controller's code. Check out the source! </aside>
       authenticated: true
     headers:
+      Authorization: 'Bearer {YOUR_AUTH_KEY}'
       Content-Type: application/json
       Accept: application/json
     urlParameters: []
@@ -74,7 +75,7 @@ endpoints:
         name: due_at
         description: 'Due date for the side project. Must be a valid date. Must be a valid date in the format <code>Ymd</code>. Must be a date after <code>today</code>.'
         required: false
-        example: '2077-09-25'
+        example: '2077-09-26'
         type: string
     responses: []
     responseFields: []
@@ -105,7 +106,7 @@ endpoints:
     responses:
       -
         status: 200
-        content: '{"data":{"name":"quo quo molestias","description":"Tempora aspernatur officiis omnis sed similique et et.","due_date":"20241229","owner":{"id":1,"name":"Pete","email":"[email protected]","email_verified_at":null,"created_at":"2021-05-29T22:53:05.000000Z","updated_at":"2021-05-29T22:53:05.000000Z"}}}'
+        content: '{"data":{"name":"quo quo molestias","description":"Tempora aspernatur officiis omnis sed similique et et.","due_date":"20241230","owner":{"id":1,"name":"Pete","email":"[email protected]","email_verified_at":null,"created_at":"2021-05-29T22:53:05.000000Z","updated_at":"2021-05-29T22:53:05.000000Z"}}}'
         headers: []
         description: null
     responseFields: []

.scribe/endpoints/2.yaml

@@ -60,7 +60,7 @@ endpoints:
     responses:
       -
         status: 200
-        content: '{"data":{"id":6,"name":"Dr. Kallie Schroeder","email":"[email protected]","side_projects":[{"id":10,"name":"similique et et","description":"Odit molestiae non est nostrum sunt.","url":null,"due_at":"20221027","created_at":"2021-06-01T16:38:10.000000Z","updated_at":"2021-06-01T16:38:10.000000Z","user_id":"6"}]}}'
+        content: '{"data":{"id":6,"name":"Dr. Kallie Schroeder","email":"[email protected]","side_projects":[{"id":10,"name":"similique et et","description":"Odit molestiae non est nostrum sunt.","url":null,"due_at":"20221027","created_at":"2021-06-02T12:17:43.000000Z","updated_at":"2021-06-02T12:17:43.000000Z","user_id":"6"}]}}'
         headers: []
         description: null
       -

config/scribe.php

@@ -194,7 +194,7 @@
         /*
          * Set this to true if any endpoints in your API use authentication.
          */
-        'enabled' => false,
+        'enabled' => true,
 
         /*
          * Set this to true if your API should be authenticated by default. If so, you must also set `enabled` (above) to true.
@@ -230,7 +230,7 @@
          * Any extra authentication-related info for your users. For instance, you can describe how to find or generate their auth credentials.
          * Markdown and HTML are supported.
          */
-        'extra_info' => 'You can retrieve your token by visiting your dashboard and clicking <b>Generate API token</b>.',
+        'extra_info' => 'You can retrieve your token by using the `users/auth` endpoint.',
     ],
 
     /*

docs/collection.json

@@ -10,7 +10,7 @@
     ],
     "info": {
         "name": "The SideProject API",
-        "_postman_id": "853ce7e2-9158-4216-b6a9-cb651c4fb039",
+        "_postman_id": "83ebb8f9-300a-499f-8343-f4af9197109f",
         "description": "Start (and never finish) side projects with this API.",
         "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json"
     },
@@ -156,7 +156,7 @@
                         ],
                         "body": {
                             "mode": "raw",
-                            "raw": "{\"name\":\"The SideProject API\",\"description\":\"ovsnvfcwodowljclfphodypoplikvyotjovrjudbmxqvvdlccjyfgdivsjtacjokurmwmxjffismejdaobevyfcbyleqjgqcoefmvdnrazszstfwulwyendppvmxeocdljwpxkslcereqwua\",\"url\":\"http:\\\/\\\/www.smitham.info\\\/consequatur-tempora-aspernatur-officiis-omnis-sed-similique.html\",\"due_at\":\"2077-09-25\"}"
+                            "raw": "{\"name\":\"The SideProject API\",\"description\":\"ovsnvfcwodowljclfphodypoplikvyotjovrjudbmxqvvdlccjyfgdivsjtacjokurmwmxjffismejdaobevyfcbyleqjgqcoefmvdnrazszstfwulwyendppvmxeocdljwpxkslcereqwua\",\"url\":\"http:\\\/\\\/www.smitham.info\\\/consequatur-tempora-aspernatur-officiis-omnis-sed-similique.html\",\"due_at\":\"2077-09-26\"}"
                         },
                         "description": "_Even though we both know you'll never finish it._\n\nThis endpoint's body parameters were automatically generated by Scribe\nfrom the controller's code. Check out the source! <\/aside>"
                     },
@@ -197,7 +197,7 @@
                         {
                             "header": [],
                             "code": 200,
-                            "body": "{\"data\":{\"name\":\"quo quo molestias\",\"description\":\"Tempora aspernatur officiis omnis sed similique et et.\",\"due_date\":\"20241229\",\"owner\":{\"id\":1,\"name\":\"Pete\",\"email\":\"[email protected]\",\"email_verified_at\":null,\"created_at\":\"2021-05-29T22:53:05.000000Z\",\"updated_at\":\"2021-05-29T22:53:05.000000Z\"}}}",
+                            "body": "{\"data\":{\"name\":\"quo quo molestias\",\"description\":\"Tempora aspernatur officiis omnis sed similique et et.\",\"due_date\":\"20241230\",\"owner\":{\"id\":1,\"name\":\"Pete\",\"email\":\"[email protected]\",\"email_verified_at\":null,\"created_at\":\"2021-05-29T22:53:05.000000Z\",\"updated_at\":\"2021-05-29T22:53:05.000000Z\"}}}",
                             "name": null
                         }
                     ]
@@ -337,7 +337,7 @@
                         {
                             "header": [],
                             "code": 200,
-                            "body": "{\"data\":{\"id\":6,\"name\":\"Dr. Kallie Schroeder\",\"email\":\"[email protected]\",\"side_projects\":[{\"id\":10,\"name\":\"similique et et\",\"description\":\"Odit molestiae non est nostrum sunt.\",\"url\":null,\"due_at\":\"20221027\",\"created_at\":\"2021-06-01T16:38:10.000000Z\",\"updated_at\":\"2021-06-01T16:38:10.000000Z\",\"user_id\":\"6\"}]}}",
+                            "body": "{\"data\":{\"id\":6,\"name\":\"Dr. Kallie Schroeder\",\"email\":\"[email protected]\",\"side_projects\":[{\"id\":10,\"name\":\"similique et et\",\"description\":\"Odit molestiae non est nostrum sunt.\",\"url\":null,\"due_at\":\"20221027\",\"created_at\":\"2021-06-02T12:17:43.000000Z\",\"updated_at\":\"2021-06-02T12:17:43.000000Z\",\"user_id\":\"6\"}]}}",
                             "name": null
                         },
                         {
@@ -458,6 +458,6 @@
         }
     ],
     "auth": {
-        "type": "noauth"
+        "type": "bearer"
     }
 }

docs/index.html

@@ -53,7 +53,7 @@
                             <li><a href="openapi.yaml">View OpenAPI spec</a></li>
                     </ul>
             <ul class="toc-footer" id="last-updated">
-            <li>Last updated: June 1 2021</li>
+            <li>Last updated: June 2 2021</li>
         </ul>
 </div>
 <div class="page-wrapper">
@@ -73,7 +73,9 @@ <h1>Introduction</h1>
 <pre><code class="language-yaml">http://testapi.com</code></pre>
 
         <h1>Authenticating requests</h1>
-<p>This API is not authenticated.</p>
+<p>To authenticate requests, include an <strong><code>Authorization</code></strong> header with the value <strong><code>"Bearer {YOUR_AUTH_KEY}"</code></strong>.</p>
+<p>All authenticated endpoints are marked with a <code>requires authentication</code> badge in the documentation below.</p>
+<p>You can retrieve your token by using the <code>users/auth</code> endpoint.</p>
 
         <h1 id="general">General</h1>
     <p>
@@ -477,15 +479,17 @@ <h2 id="side-projects-POSTapi-side_projects">Start a new side project</h2>
 
 <pre><code class="language-bash">curl --request POST \
     "http://testapi.com/api/side_projects" \
+    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
     --header "Content-Type: application/json" \
     --header "Accept: application/json" \
-    --data "{\"name\":\"The SideProject API\",\"description\":\"ovsnvfcwodowljclfphodypoplikvyotjovrjudbmxqvvdlccjyfgdivsjtacjokurmwmxjffismejdaobevyfcbyleqjgqcoefmvdnrazszstfwulwyendppvmxeocdljwpxkslcereqwua\",\"url\":\"http:\\/\\/www.smitham.info\\/consequatur-tempora-aspernatur-officiis-omnis-sed-similique.html\",\"due_at\":\"2077-09-25\"}"</code></pre>
+    --data "{\"name\":\"The SideProject API\",\"description\":\"ovsnvfcwodowljclfphodypoplikvyotjovrjudbmxqvvdlccjyfgdivsjtacjokurmwmxjffismejdaobevyfcbyleqjgqcoefmvdnrazszstfwulwyendppvmxeocdljwpxkslcereqwua\",\"url\":\"http:\\/\\/www.smitham.info\\/consequatur-tempora-aspernatur-officiis-omnis-sed-similique.html\",\"due_at\":\"2077-09-26\"}"</code></pre>
 
 <pre><code class="language-javascript">const url = new URL(
     "http://testapi.com/api/side_projects"
 );
 
 let headers = {
+    "Authorization": "Bearer {YOUR_AUTH_KEY}",
     "Content-Type": "application/json",
     "Accept": "application/json",
 };
@@ -494,7 +498,7 @@ <h2 id="side-projects-POSTapi-side_projects">Start a new side project</h2>
     "name": "The SideProject API",
     "description": "ovsnvfcwodowljclfphodypoplikvyotjovrjudbmxqvvdlccjyfgdivsjtacjokurmwmxjffismejdaobevyfcbyleqjgqcoefmvdnrazszstfwulwyendppvmxeocdljwpxkslcereqwua",
     "url": "http:\/\/www.smitham.info\/consequatur-tempora-aspernatur-officiis-omnis-sed-similique.html",
-    "due_at": "2077-09-25"
+    "due_at": "2077-09-26"
 }
 
 fetch(url, {
@@ -508,13 +512,14 @@ <h2 id="side-projects-POSTapi-side_projects">Start a new side project</h2>
     'http://testapi.com/api/side_projects',
     [
         'headers' =&gt; [
+            'Authorization' =&gt; 'Bearer {YOUR_AUTH_KEY}',
             'Accept' =&gt; 'application/json',
         ],
         'json' =&gt; [
             'name' =&gt; 'The SideProject API',
             'description' =&gt; 'ovsnvfcwodowljclfphodypoplikvyotjovrjudbmxqvvdlccjyfgdivsjtacjokurmwmxjffismejdaobevyfcbyleqjgqcoefmvdnrazszstfwulwyendppvmxeocdljwpxkslcereqwua',
             'url' =&gt; 'http://www.smitham.info/consequatur-tempora-aspernatur-officiis-omnis-sed-similique.html',
-            'due_at' =&gt; '2077-09-25',
+            'due_at' =&gt; '2077-09-26',
         ],
     ]
 );
@@ -529,9 +534,10 @@ <h2 id="side-projects-POSTapi-side_projects">Start a new side project</h2>
     "name": "The SideProject API",
     "description": "ovsnvfcwodowljclfphodypoplikvyotjovrjudbmxqvvdlccjyfgdivsjtacjokurmwmxjffismejdaobevyfcbyleqjgqcoefmvdnrazszstfwulwyendppvmxeocdljwpxkslcereqwua",
     "url": "http:\/\/www.smitham.info\/consequatur-tempora-aspernatur-officiis-omnis-sed-similique.html",
-    "due_at": "2077-09-25"
+    "due_at": "2077-09-26"
 }
 headers = {
+  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
   'Accept': 'application/json'
 }
 
@@ -545,9 +551,10 @@ <h2 id="side-projects-POSTapi-side_projects">Start a new side project</h2>
     "name": "The SideProject API",
     "description": "ovsnvfcwodowljclfphodypoplikvyotjovrjudbmxqvvdlccjyfgdivsjtacjokurmwmxjffismejdaobevyfcbyleqjgqcoefmvdnrazszstfwulwyendppvmxeocdljwpxkslcereqwua",
     "url": "http:\/\/www.smitham.info\/consequatur-tempora-aspernatur-officiis-omnis-sed-similique.html",
-    "due_at": "2077-09-25"
+    "due_at": "2077-09-26"
 }
 headers = {
+    "Authorization": "Bearer {YOUR_AUTH_KEY}",
     "Accept": "application/json",
 }
 
@@ -574,7 +581,7 @@ <h2 id="side-projects-POSTapi-side_projects">Start a new side project</h2>
       data-path="api/side_projects"
       data-authed="1"
       data-hasfiles=""
-      data-headers='{"Accept":"application\/json"}'
+      data-headers='{"Authorization":"Bearer {YOUR_AUTH_KEY}","Accept":"application\/json"}'
       onsubmit="event.preventDefault(); executeTryOut('POSTapi-side_projects', this);">
     <h3>
         Request&nbsp;&nbsp;&nbsp;
@@ -708,7 +715,7 @@ <h2 id="side-projects-GETapi-side_projects--id-">View a side project</h2>
     &quot;data&quot;: {
         &quot;name&quot;: &quot;quo quo molestias&quot;,
         &quot;description&quot;: &quot;Tempora aspernatur officiis omnis sed similique et et.&quot;,
-        &quot;due_date&quot;: &quot;20241229&quot;,
+        &quot;due_date&quot;: &quot;20241230&quot;,
         &quot;owner&quot;: {
             &quot;id&quot;: 1,
             &quot;name&quot;: &quot;Pete&quot;,
@@ -1234,8 +1241,8 @@ <h2 id="users-GETapi-users--id-">Fetch a user</h2>
                 &quot;description&quot;: &quot;Odit molestiae non est nostrum sunt.&quot;,
                 &quot;url&quot;: null,
                 &quot;due_at&quot;: &quot;20221027&quot;,
-                &quot;created_at&quot;: &quot;2021-06-01T16:38:10.000000Z&quot;,
-                &quot;updated_at&quot;: &quot;2021-06-01T16:38:10.000000Z&quot;,
+                &quot;created_at&quot;: &quot;2021-06-02T12:17:43.000000Z&quot;,
+                &quot;updated_at&quot;: &quot;2021-06-02T12:17:43.000000Z&quot;,
                 &quot;user_id&quot;: &quot;6&quot;
             }
         ]
@@ -1711,7 +1718,9 @@ <h4 class="fancy-heading-panel"><b>Response Fields</b></h4>
 <p>The new API token. Valid forever.</p>        </p>
 
 
-        
+        <h1>Some extra info</h1>
+<p>Just some extra info added via an <code>append.md</code> file.</p>
+<p>Go on, <a href="https://github.com/knuckleswtf/scribe">go check Scribe out</a> 😄.</p>
     </div>
     <div class="dark-box">
                     <div class="lang-selector">