Skip to content

Commit 713b24c

Browse files
committed
Generate docs
1 parent 2c7f74b commit 713b24c

18 files changed

+4116
-39
lines changed

.scribe/.filemtimes

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=1622334471
4-
.scribe/authentication.md=1622334471
3+
.scribe/index.md=1622334857
4+
.scribe/authentication.md=1622334857

.scribe/endpoints.cache/0.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ endpoints:
3232
x-ratelimit-limit:
3333
- 60
3434
x-ratelimit-remaining:
35-
- 56
35+
- 59
3636
access-control-allow-origin:
3737
- '*'
3838
description: null

.scribe/endpoints.cache/1.yaml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ endpoints:
2929
x-ratelimit-limit:
3030
- 60
3131
x-ratelimit-remaining:
32-
- 54
32+
- 57
3333
access-control-allow-origin:
3434
- '*'
3535
description: null
@@ -62,19 +62,19 @@ endpoints:
6262
name: description
6363
description: 'A longer description of your side project. The value must not be greater than 255 characters.'
6464
required: false
65-
example: dnrllzuojuojsfdgxmtkywbhcumnxqrw
65+
example: szzvblztjfkdcmbnyysgwaagmzzqsujuvpbfznqhdmixenuexclndzcqzufmzfuqiwccyiaskjwvgupofzwbgfpegblnuzsqqpbqgsgfgujnefakxbecccbmogvbydjszntyazlkgsgsuhzyqiedsqyvwgepiotomphpxrfgxkhgeqpwtjtnkguxdbmuwsscywbgmerhulfvznigtfezrgmmngkmltynhsenqenrgwhpklflyedqiwuhkcyy
6666
type: string
6767
url:
6868
name: url
6969
description: 'A url to your side project. The value must be a valid URL.'
7070
required: false
71-
example: 'http://wilkinson.com/molestiae-ut-repellendus-a.html'
71+
example: 'http://www.lemke.info/id-nihil-earum-minima-ea-quis-tempora.html'
7272
type: string
7373
due_at:
7474
name: due_at
7575
description: 'Due date for the side project. The value must be a valid date. The value must be a valid date in the format Ymd. The value must be a date after <code>today</code>.'
7676
required: false
77-
example: '2061-08-18'
77+
example: '2062-01-04'
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: 8
101+
example: 5
102102
type: integer
103103
queryParameters: []
104104
bodyParameters: []
105105
responses:
106106
-
107107
status: 200
108-
content: '{"data":{"name":"magnam consequatur fugit","description":"Sapiente nesciunt impedit et doloremque consectetur fugiat debitis perferendis.","due_date":"20280607","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":"voluptatem mollitia odit","description":"Atque molestiae soluta libero vitae pariatur at.","due_date":"20240222","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: []
@@ -115,7 +115,7 @@ endpoints:
115115
- PATCH
116116
uri: 'api/side_projects/{id}'
117117
metadata:
118-
title: 'Update the specified resource in storage.'
118+
title: 'Update a side project'
119119
description: ''
120120
authenticated: false
121121
headers:
@@ -126,7 +126,7 @@ endpoints:
126126
name: id
127127
description: 'The ID of the side project.'
128128
required: true
129-
example: 7
129+
example: 3
130130
type: integer
131131
queryParameters: []
132132
bodyParameters: []
@@ -137,7 +137,7 @@ endpoints:
137137
- DELETE
138138
uri: 'api/side_projects/{id}'
139139
metadata:
140-
title: 'Remove the specified resource from storage.'
140+
title: 'Delete a side project'
141141
description: ''
142142
authenticated: false
143143
headers:
@@ -148,7 +148,7 @@ endpoints:
148148
name: id
149149
description: 'The ID of the side project.'
150150
required: true
151-
example: 14
151+
example: 16
152152
type: integer
153153
queryParameters: []
154154
bodyParameters: []

.scribe/endpoints.cache/2.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@ endpoints:
2121
name: name
2222
description: 'The value must be at least 1 characters. The value must not be greater than 255 characters.'
2323
required: true
24-
example: orregrvsahjxxbbazsqbayaljjwdmkuyokpezwnrxiyaqdyavlphcnyhqrurjjgjmvzjfsdbrcjrcrunrnveaaqednmgohqfdukuivvlziwofjsytyq
24+
example: smwrfzagusffdunbvldexcnxwwlekvhhzuadousqjqlzhfjyrjieurdsegqxaadncagszmgajcaoasevirpdknbggkemhnvgupmxxqfwbfkkpitdcjcowrrajpflaltrcdwfnicxxibboaqtkqr
2525
type: string
2626
email:
2727
name: email
2828
description: 'The value must be a valid email address.'
2929
required: true
30-
example: deon66@example.com
30+
example: lemke.jillian@example.com
3131
type: string
3232
password:
3333
name: password
3434
description: ''
3535
required: true
36-
example: dolores
36+
example: nemo
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: 11
58+
example: 8
5959
type: integer
6060
queryParameters: []
6161
bodyParameters: []
6262
responses:
6363
-
6464
status: 200
65-
content: '{"data":{"id":6,"name":"Ron Legros","email":"annette69@example.org","side_projects":[{"id":10,"name":"est quam magnam","description":"Sed harum voluptatibus et ut.","url":null,"due_at":"20290415","created_at":"2021-05-30T00:27:50.000000Z","updated_at":"2021-05-30T00:27:50.000000Z","user_id":"6"}]}}'
65+
content: '{"data":{"id":6,"name":"Alvina Krajcik","email":"rhoda22@example.net","side_projects":[{"id":10,"name":"labore neque necessitatibus","description":"Et omnis occaecati aut ab porro est qui harum.","url":null,"due_at":"20250126","created_at":"2021-05-30T00:34:17.000000Z","updated_at":"2021-05-30T00:34:17.000000Z","user_id":"6"}]}}'
6666
headers: []
6767
description: null
6868
-
@@ -113,7 +113,7 @@ endpoints:
113113
x-ratelimit-limit:
114114
- 60
115115
x-ratelimit-remaining:
116-
- 55
116+
- 58
117117
access-control-allow-origin:
118118
- '*'
119119
description: null
@@ -137,7 +137,7 @@ endpoints:
137137
name: id
138138
description: 'The ID of the user.'
139139
required: true
140-
example: 9
140+
example: 11
141141
type: integer
142142
queryParameters: []
143143
bodyParameters: []

.scribe/endpoints/0.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ endpoints:
3030
x-ratelimit-limit:
3131
- 60
3232
x-ratelimit-remaining:
33-
- 56
33+
- 59
3434
access-control-allow-origin:
3535
- '*'
3636
description: null

.scribe/endpoints/1.yaml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ endpoints:
2727
x-ratelimit-limit:
2828
- 60
2929
x-ratelimit-remaining:
30-
- 54
30+
- 57
3131
access-control-allow-origin:
3232
- '*'
3333
description: null
@@ -60,19 +60,19 @@ endpoints:
6060
name: description
6161
description: 'A longer description of your side project. The value must not be greater than 255 characters.'
6262
required: false
63-
example: dnrllzuojuojsfdgxmtkywbhcumnxqrw
63+
example: szzvblztjfkdcmbnyysgwaagmzzqsujuvpbfznqhdmixenuexclndzcqzufmzfuqiwccyiaskjwvgupofzwbgfpegblnuzsqqpbqgsgfgujnefakxbecccbmogvbydjszntyazlkgsgsuhzyqiedsqyvwgepiotomphpxrfgxkhgeqpwtjtnkguxdbmuwsscywbgmerhulfvznigtfezrgmmngkmltynhsenqenrgwhpklflyedqiwuhkcyy
6464
type: string
6565
url:
6666
name: url
6767
description: 'A url to your side project. The value must be a valid URL.'
6868
required: false
69-
example: 'http://wilkinson.com/molestiae-ut-repellendus-a.html'
69+
example: 'http://www.lemke.info/id-nihil-earum-minima-ea-quis-tempora.html'
7070
type: string
7171
due_at:
7272
name: due_at
7373
description: 'Due date for the side project. The value must be a valid date. The value must be a valid date in the format Ymd. The value must be a date after <code>today</code>.'
7474
required: false
75-
example: '2061-08-18'
75+
example: '2062-01-04'
7676
type: string
7777
responses: []
7878
responseFields: []
@@ -96,14 +96,14 @@ endpoints:
9696
name: id
9797
description: 'The ID of the side project.'
9898
required: true
99-
example: 8
99+
example: 5
100100
type: integer
101101
queryParameters: []
102102
bodyParameters: []
103103
responses:
104104
-
105105
status: 200
106-
content: '{"data":{"name":"magnam consequatur fugit","description":"Sapiente nesciunt impedit et doloremque consectetur fugiat debitis perferendis.","due_date":"20280607","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"}}}'
106+
content: '{"data":{"name":"voluptatem mollitia odit","description":"Atque molestiae soluta libero vitae pariatur at.","due_date":"20240222","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"}}}'
107107
headers: []
108108
description: null
109109
responseFields: []
@@ -113,7 +113,7 @@ endpoints:
113113
- PATCH
114114
uri: 'api/side_projects/{id}'
115115
metadata:
116-
title: 'Update the specified resource in storage.'
116+
title: 'Update a side project'
117117
description: ''
118118
authenticated: false
119119
headers:
@@ -124,7 +124,7 @@ endpoints:
124124
name: id
125125
description: 'The ID of the side project.'
126126
required: true
127-
example: 7
127+
example: 3
128128
type: integer
129129
queryParameters: []
130130
bodyParameters: []
@@ -135,7 +135,7 @@ endpoints:
135135
- DELETE
136136
uri: 'api/side_projects/{id}'
137137
metadata:
138-
title: 'Remove the specified resource from storage.'
138+
title: 'Delete a side project'
139139
description: ''
140140
authenticated: false
141141
headers:
@@ -146,7 +146,7 @@ endpoints:
146146
name: id
147147
description: 'The ID of the side project.'
148148
required: true
149-
example: 14
149+
example: 16
150150
type: integer
151151
queryParameters: []
152152
bodyParameters: []

.scribe/endpoints/2.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,19 @@ endpoints:
1919
name: name
2020
description: 'The value must be at least 1 characters. The value must not be greater than 255 characters.'
2121
required: true
22-
example: orregrvsahjxxbbazsqbayaljjwdmkuyokpezwnrxiyaqdyavlphcnyhqrurjjgjmvzjfsdbrcjrcrunrnveaaqednmgohqfdukuivvlziwofjsytyq
22+
example: smwrfzagusffdunbvldexcnxwwlekvhhzuadousqjqlzhfjyrjieurdsegqxaadncagszmgajcaoasevirpdknbggkemhnvgupmxxqfwbfkkpitdcjcowrrajpflaltrcdwfnicxxibboaqtkqr
2323
type: string
2424
email:
2525
name: email
2626
description: 'The value must be a valid email address.'
2727
required: true
28-
example: deon66@example.com
28+
example: lemke.jillian@example.com
2929
type: string
3030
password:
3131
name: password
3232
description: ''
3333
required: true
34-
example: dolores
34+
example: nemo
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: 11
56+
example: 8
5757
type: integer
5858
queryParameters: []
5959
bodyParameters: []
6060
responses:
6161
-
6262
status: 200
63-
content: '{"data":{"id":6,"name":"Ron Legros","email":"annette69@example.org","side_projects":[{"id":10,"name":"est quam magnam","description":"Sed harum voluptatibus et ut.","url":null,"due_at":"20290415","created_at":"2021-05-30T00:27:50.000000Z","updated_at":"2021-05-30T00:27:50.000000Z","user_id":"6"}]}}'
63+
content: '{"data":{"id":6,"name":"Alvina Krajcik","email":"rhoda22@example.net","side_projects":[{"id":10,"name":"labore neque necessitatibus","description":"Et omnis occaecati aut ab porro est qui harum.","url":null,"due_at":"20250126","created_at":"2021-05-30T00:34:17.000000Z","updated_at":"2021-05-30T00:34:17.000000Z","user_id":"6"}]}}'
6464
headers: []
6565
description: null
6666
-
@@ -111,7 +111,7 @@ endpoints:
111111
x-ratelimit-limit:
112112
- 60
113113
x-ratelimit-remaining:
114-
- 55
114+
- 58
115115
access-control-allow-origin:
116116
- '*'
117117
description: null
@@ -135,7 +135,7 @@ endpoints:
135135
name: id
136136
description: 'The ID of the user.'
137137
required: true
138-
example: 9
138+
example: 11
139139
type: integer
140140
queryParameters: []
141141
bodyParameters: []

.scribe/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ This documentation aims to provide all the information you need to work with our
77
<aside class="success">Example of aside with class=success.</aside>
88
<aside class="warning">Example of aside with class=warning.</aside>
99

10+
This is an unfinished API (get it?), but hopefully it should be enough to convince you to try Scribe out.😉
11+
1012
<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
1113
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>
1214

config/scribe.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@
138138
* - "static" will generate a static HTMl page in the /public/docs folder,
139139
* - "laravel" will generate the documentation as a Blade view, so you can add routing and authentication.
140140
*/
141-
'type' => 'laravel',
141+
'type' => 'static',
142142

143143
/*
144144
* Settings for `static` type output.

0 commit comments

Comments
 (0)