Skip to content

Commit 1515977

Browse files
committed
Update docs link
1 parent 97d2baf commit 1515977

File tree

14 files changed

+179
-179
lines changed

14 files changed

+179
-179
lines changed

.scribe/.filehashes

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# GENERATED. YOU SHOULDN'T MODIFY OR DELETE THIS FILE.
22
# Scribe uses this file to know when you change something manually in your docs.
3-
.scribe/index.md=1622336665
4-
.scribe/authentication.md=1622336665
3+
.scribe/index.md=64f1cd5ab919e7da2c8d8a2e8a6eafdf
4+
.scribe/authentication.md=325963d01b9a982f33c1f72830d5786d

.scribe/endpoints.cache/1.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,19 +64,19 @@ endpoints:
6464
name: description
6565
description: 'A longer description of your side project. Must not be greater than 255 characters.'
6666
required: false
67-
example: pgqjigojmheiufuugyeraqcamzgjbqbfqbumnhjkamvcyqyjembuczzfvpzmyjfwqbejzuccxjojnmmnudzldufmhxtgjwzjehxpzsjczlumelaxizdfjh
67+
example: sogdteihlaodtuesxlcjccmumvueaqrzmrjzxagwffmmojyubrekpbmhsbokzkztsiikazrxqdgtonbqleghxiwfoopcjvrhbdacaeylhnfyjkhcptvqkngkengcntvxqlsurucdxvuylbglmeyynmxreohvojahkyqyowxtlewslgeibjfwgyrjovircbjzllbjibvzjcuktprzuszolftzuxeafvmsfkqqsetgbzrjqovztqyxohzmncroo
6868
type: string
6969
url:
7070
name: url
7171
description: 'A url to your side project. Must be a valid URL.'
7272
required: false
73-
example: 'http://heaney.info/officia-ducimus-ratione-quisquam-ut-ad-nulla-doloremque'
73+
example: 'https://www.rohan.com/quia-aperiam-alias-qui-facere-vitae'
7474
type: string
7575
due_at:
7676
name: due_at
7777
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>.'
7878
required: false
79-
example: '2038-07-30'
79+
example: '2087-12-08'
8080
type: string
8181
responses: []
8282
responseFields: []
@@ -100,14 +100,14 @@ endpoints:
100100
name: id
101101
description: 'The ID of the side project.'
102102
required: true
103-
example: 7
103+
example: 9
104104
type: integer
105105
queryParameters: []
106106
bodyParameters: []
107107
responses:
108108
-
109109
status: 200
110-
content: '{"data":{"name":"quia culpa quo","description":"Qui est maiores nulla perferendis aliquam.","due_date":"20230214","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"}}}'
110+
content: '{"data":{"name":"incidunt laudantium cupiditate","description":"Accusantium ut dolores debitis ut et.","due_date":"20220707","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"}}}'
111111
headers: []
112112
description: null
113113
responseFields: []
@@ -128,7 +128,7 @@ endpoints:
128128
name: id
129129
description: 'The ID of the side project.'
130130
required: true
131-
example: 7
131+
example: 14
132132
type: integer
133133
queryParameters: []
134134
bodyParameters: []
@@ -150,7 +150,7 @@ endpoints:
150150
name: id
151151
description: 'The ID of the side project.'
152152
required: true
153-
example: 7
153+
example: 14
154154
type: integer
155155
queryParameters: []
156156
bodyParameters: []

.scribe/endpoints.cache/2.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@ endpoints:
2121
name: name
2222
description: 'Must be at least 1 characters. Must not be greater than 255 characters.'
2323
required: true
24-
example: bunnfbbngqakqsbubcxdhjxlmfotfeuxyaiiqegvmawtqwmbxlysklhkwzbrodbxcbjmxrqifnupynzlewpelcjvddycjyyfjhqwguarckqlqyagmtkxhaukyczsmlbuqovyhyheegoevpqiasuegwoerrqfjlilzimjvzqotrdabocpprqashifyrscszpnciuxqmgpiizqirmbtqqy
24+
example: iyvesjvapprtnqekbbuconazxeqwxsdisrbawwoxwbrpoalydexicizlwatouoarqlvu
2525
type: string
2626
email:
2727
name: email
2828
description: 'Must be a valid email address.'
2929
required: true
30-
example: hodkiewicz.hosea@example.net
30+
example: felipa38@example.net
3131
type: string
3232
password:
3333
name: password
3434
description: ''
3535
required: true
36-
example: voluptatem
36+
example: soluta
3737
type: string
3838
responses: []
3939
responseFields: []
@@ -55,14 +55,14 @@ endpoints:
5555
name: id
5656
description: 'The ID of the user.'
5757
required: true
58-
example: 20
58+
example: 9
5959
type: integer
6060
queryParameters: []
6161
bodyParameters: []
6262
responses:
6363
-
6464
status: 200
65-
content: '{"data":{"id":6,"name":"Dr. Hayley Lueilwitz V","email":"donato96@example.net","side_projects":[{"id":10,"name":"dolorem rerum impedit","description":"Excepturi quis id blanditiis culpa facilis error error.","url":null,"due_at":"20301016","created_at":"2021-05-31T16:38:20.000000Z","updated_at":"2021-05-31T16:38:20.000000Z","user_id":"6"}]}}'
65+
content: '{"data":{"id":6,"name":"Waylon Dickinson","email":"wfriesen@example.org","side_projects":[{"id":10,"name":"iusto dolor neque","description":"Aliquam quia quis ratione iure.","url":null,"due_at":"20280228","created_at":"2021-05-31T16:44:48.000000Z","updated_at":"2021-05-31T16:44:48.000000Z","user_id":"6"}]}}'
6666
headers: []
6767
description: null
6868
-
@@ -137,7 +137,7 @@ endpoints:
137137
name: id
138138
description: 'The ID of the user.'
139139
required: true
140-
example: 20
140+
example: 4
141141
type: integer
142142
queryParameters: []
143143
bodyParameters: []

.scribe/endpoints/1.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,19 +62,19 @@ endpoints:
6262
name: description
6363
description: 'A longer description of your side project. Must not be greater than 255 characters.'
6464
required: false
65-
example: pgqjigojmheiufuugyeraqcamzgjbqbfqbumnhjkamvcyqyjembuczzfvpzmyjfwqbejzuccxjojnmmnudzldufmhxtgjwzjehxpzsjczlumelaxizdfjh
65+
example: sogdteihlaodtuesxlcjccmumvueaqrzmrjzxagwffmmojyubrekpbmhsbokzkztsiikazrxqdgtonbqleghxiwfoopcjvrhbdacaeylhnfyjkhcptvqkngkengcntvxqlsurucdxvuylbglmeyynmxreohvojahkyqyowxtlewslgeibjfwgyrjovircbjzllbjibvzjcuktprzuszolftzuxeafvmsfkqqsetgbzrjqovztqyxohzmncroo
6666
type: string
6767
url:
6868
name: url
6969
description: 'A url to your side project. Must be a valid URL.'
7070
required: false
71-
example: 'http://heaney.info/officia-ducimus-ratione-quisquam-ut-ad-nulla-doloremque'
71+
example: 'https://www.rohan.com/quia-aperiam-alias-qui-facere-vitae'
7272
type: string
7373
due_at:
7474
name: due_at
7575
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>.'
7676
required: false
77-
example: '2038-07-30'
77+
example: '2087-12-08'
7878
type: string
7979
responses: []
8080
responseFields: []
@@ -98,14 +98,14 @@ endpoints:
9898
name: id
9999
description: 'The ID of the side project.'
100100
required: true
101-
example: 7
101+
example: 9
102102
type: integer
103103
queryParameters: []
104104
bodyParameters: []
105105
responses:
106106
-
107107
status: 200
108-
content: '{"data":{"name":"quia culpa quo","description":"Qui est maiores nulla perferendis aliquam.","due_date":"20230214","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"}}}'
108+
content: '{"data":{"name":"incidunt laudantium cupiditate","description":"Accusantium ut dolores debitis ut et.","due_date":"20220707","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"}}}'
109109
headers: []
110110
description: null
111111
responseFields: []
@@ -126,7 +126,7 @@ endpoints:
126126
name: id
127127
description: 'The ID of the side project.'
128128
required: true
129-
example: 7
129+
example: 14
130130
type: integer
131131
queryParameters: []
132132
bodyParameters: []
@@ -148,7 +148,7 @@ endpoints:
148148
name: id
149149
description: 'The ID of the side project.'
150150
required: true
151-
example: 7
151+
example: 14
152152
type: integer
153153
queryParameters: []
154154
bodyParameters: []

.scribe/endpoints/2.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,19 @@ endpoints:
1919
name: name
2020
description: 'Must be at least 1 characters. Must not be greater than 255 characters.'
2121
required: true
22-
example: bunnfbbngqakqsbubcxdhjxlmfotfeuxyaiiqegvmawtqwmbxlysklhkwzbrodbxcbjmxrqifnupynzlewpelcjvddycjyyfjhqwguarckqlqyagmtkxhaukyczsmlbuqovyhyheegoevpqiasuegwoerrqfjlilzimjvzqotrdabocpprqashifyrscszpnciuxqmgpiizqirmbtqqy
22+
example: iyvesjvapprtnqekbbuconazxeqwxsdisrbawwoxwbrpoalydexicizlwatouoarqlvu
2323
type: string
2424
email:
2525
name: email
2626
description: 'Must be a valid email address.'
2727
required: true
28-
example: hodkiewicz.hosea@example.net
28+
example: felipa38@example.net
2929
type: string
3030
password:
3131
name: password
3232
description: ''
3333
required: true
34-
example: voluptatem
34+
example: soluta
3535
type: string
3636
responses: []
3737
responseFields: []
@@ -53,14 +53,14 @@ endpoints:
5353
name: id
5454
description: 'The ID of the user.'
5555
required: true
56-
example: 20
56+
example: 9
5757
type: integer
5858
queryParameters: []
5959
bodyParameters: []
6060
responses:
6161
-
6262
status: 200
63-
content: '{"data":{"id":6,"name":"Dr. Hayley Lueilwitz V","email":"donato96@example.net","side_projects":[{"id":10,"name":"dolorem rerum impedit","description":"Excepturi quis id blanditiis culpa facilis error error.","url":null,"due_at":"20301016","created_at":"2021-05-31T16:38:20.000000Z","updated_at":"2021-05-31T16:38:20.000000Z","user_id":"6"}]}}'
63+
content: '{"data":{"id":6,"name":"Waylon Dickinson","email":"wfriesen@example.org","side_projects":[{"id":10,"name":"iusto dolor neque","description":"Aliquam quia quis ratione iure.","url":null,"due_at":"20280228","created_at":"2021-05-31T16:44:48.000000Z","updated_at":"2021-05-31T16:44:48.000000Z","user_id":"6"}]}}'
6464
headers: []
6565
description: null
6666
-
@@ -135,7 +135,7 @@ endpoints:
135135
name: id
136136
description: 'The ID of the user.'
137137
required: true
138-
example: 20
138+
example: 4
139139
type: integer
140140
queryParameters: []
141141
bodyParameters: []

.scribe/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Start (and never finish) side projects with this API.
44

5-
The SideProject API is a sample API, built to demonstrate Scribe's capabilities.
5+
The SideProject API is a sample API, built to demonstrate [Scribe's](http://scribe.knuckles.wtf) capabilities.
66

77
Lke many side projects, it is itself an unfinished API, but hopefully it should be enough to convince you to try Scribe out.😉 You can check out the source code [on GitHub](https://github.com/knuckleswtf/TheSideProjectAPI/).
88

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# The SideProject API
22

3-
Sample (Laravel) API to demonstrate [Scribe's](http://scribe.knuckles.wtf) API documentation capabilities. See the docs at [sample.scribe.knuckles.wtf](http://sample.scribe.knuckles.wtf).
3+
Sample (Laravel) API to demonstrate [Scribe's](http://scribe.knuckles.wtf) API documentation capabilities. See the docs at [demo.scribe.knuckles.wtf](http://demo.scribe.knuckles.wtf).
44

55

66
The docs are built with `php artisan scribe:generate`, and then moved into the docs/ folder and file paths changed, so that GitHub Pages can work with them. This two-step process is handled with the `composer docs` command.

config/scribe.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@
237237
* Text to place in the "Introduction" section, right after the `description`. Markdown and HTML are supported.
238238
*/
239239
'intro_text' => <<<INTRO
240-
The SideProject API is a sample API, built to demonstrate Scribe's capabilities.
240+
The SideProject API is a sample API, built to demonstrate [Scribe's](http://scribe.knuckles.wtf) capabilities.
241241
242242
Lke many side projects, it is itself an unfinished API, but hopefully it should be enough to convince you to try Scribe out.😉 You can check out the source code [on GitHub](https://github.com/knuckleswtf/TheSideProjectAPI/).
243243

docs/collection.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
],
1111
"info": {
1212
"name": "The SideProject API",
13-
"_postman_id": "dfa93daf-609c-460b-a843-5a6ec5aea2a6",
13+
"_postman_id": "52863080-895f-462d-96cf-fbf7d156f6f1",
1414
"description": "Start (and never finish) side projects with this API.",
1515
"schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json"
1616
},
@@ -156,7 +156,7 @@
156156
],
157157
"body": {
158158
"mode": "raw",
159-
"raw": "{\"name\":\"\\\"The SideProject API\\\"\",\"description\":\"pgqjigojmheiufuugyeraqcamzgjbqbfqbumnhjkamvcyqyjembuczzfvpzmyjfwqbejzuccxjojnmmnudzldufmhxtgjwzjehxpzsjczlumelaxizdfjh\",\"url\":\"http:\\\/\\\/heaney.info\\\/officia-ducimus-ratione-quisquam-ut-ad-nulla-doloremque\",\"due_at\":\"2038-07-30\"}"
159+
"raw": "{\"name\":\"\\\"The SideProject API\\\"\",\"description\":\"sogdteihlaodtuesxlcjccmumvueaqrzmrjzxagwffmmojyubrekpbmhsbokzkztsiikazrxqdgtonbqleghxiwfoopcjvrhbdacaeylhnfyjkhcptvqkngkengcntvxqlsurucdxvuylbglmeyynmxreohvojahkyqyowxtlewslgeibjfwgyrjovircbjzllbjibvzjcuktprzuszolftzuxeafvmsfkqqsetgbzrjqovztqyxohzmncroo\",\"url\":\"https:\\\/\\\/www.rohan.com\\\/quia-aperiam-alias-qui-facere-vitae\",\"due_at\":\"2087-12-08\"}"
160160
},
161161
"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>"
162162
},
@@ -175,7 +175,7 @@
175175
{
176176
"id": "id",
177177
"key": "id",
178-
"value": "7",
178+
"value": "9",
179179
"description": "The ID of the side project."
180180
}
181181
]
@@ -197,7 +197,7 @@
197197
{
198198
"header": [],
199199
"code": 200,
200-
"body": "{\"data\":{\"name\":\"quia culpa quo\",\"description\":\"Qui est maiores nulla perferendis aliquam.\",\"due_date\":\"20230214\",\"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\"}}}",
200+
"body": "{\"data\":{\"name\":\"incidunt laudantium cupiditate\",\"description\":\"Accusantium ut dolores debitis ut et.\",\"due_date\":\"20220707\",\"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\"}}}",
201201
"name": null
202202
}
203203
]
@@ -215,7 +215,7 @@
215215
{
216216
"id": "id",
217217
"key": "id",
218-
"value": "7",
218+
"value": "14",
219219
"description": "The ID of the side project."
220220
}
221221
]
@@ -248,7 +248,7 @@
248248
{
249249
"id": "id",
250250
"key": "id",
251-
"value": "7",
251+
"value": "14",
252252
"description": "The ID of the side project."
253253
}
254254
]
@@ -293,7 +293,7 @@
293293
],
294294
"body": {
295295
"mode": "raw",
296-
"raw": "{\"name\":\"bunnfbbngqakqsbubcxdhjxlmfotfeuxyaiiqegvmawtqwmbxlysklhkwzbrodbxcbjmxrqifnupynzlewpelcjvddycjyyfjhqwguarckqlqyagmtkxhaukyczsmlbuqovyhyheegoevpqiasuegwoerrqfjlilzimjvzqotrdabocpprqashifyrscszpnciuxqmgpiizqirmbtqqy\",\"email\":\"hodkiewicz.hosea@example.net\",\"password\":\"voluptatem\"}"
296+
"raw": "{\"name\":\"iyvesjvapprtnqekbbuconazxeqwxsdisrbawwoxwbrpoalydexicizlwatouoarqlvu\",\"email\":\"felipa38@example.net\",\"password\":\"soluta\"}"
297297
},
298298
"description": "This endpoint's body parameters are automatically generated from a FormRequest.",
299299
"auth": {
@@ -315,7 +315,7 @@
315315
{
316316
"id": "id",
317317
"key": "id",
318-
"value": "20",
318+
"value": "9",
319319
"description": "The ID of the user."
320320
}
321321
]
@@ -337,7 +337,7 @@
337337
{
338338
"header": [],
339339
"code": 200,
340-
"body": "{\"data\":{\"id\":6,\"name\":\"Dr. Hayley Lueilwitz V\",\"email\":\"donato96@example.net\",\"side_projects\":[{\"id\":10,\"name\":\"dolorem rerum impedit\",\"description\":\"Excepturi quis id blanditiis culpa facilis error error.\",\"url\":null,\"due_at\":\"20301016\",\"created_at\":\"2021-05-31T16:38:20.000000Z\",\"updated_at\":\"2021-05-31T16:38:20.000000Z\",\"user_id\":\"6\"}]}}",
340+
"body": "{\"data\":{\"id\":6,\"name\":\"Waylon Dickinson\",\"email\":\"wfriesen@example.org\",\"side_projects\":[{\"id\":10,\"name\":\"iusto dolor neque\",\"description\":\"Aliquam quia quis ratione iure.\",\"url\":null,\"due_at\":\"20280228\",\"created_at\":\"2021-05-31T16:44:48.000000Z\",\"updated_at\":\"2021-05-31T16:44:48.000000Z\",\"user_id\":\"6\"}]}}",
341341
"name": null
342342
},
343343
{
@@ -427,7 +427,7 @@
427427
{
428428
"id": "id",
429429
"key": "id",
430-
"value": "20",
430+
"value": "4",
431431
"description": "The ID of the user."
432432
}
433433
]

0 commit comments

Comments
 (0)