Skip to content

Commit ef096c7

Browse files
committed
Update docs
1 parent e9a653e commit ef096c7

File tree

14 files changed

+27
-4103
lines changed

14 files changed

+27
-4103
lines changed

.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: sogdteihlaodtuesxlcjccmumvueaqrzmrjzxagwffmmojyubrekpbmhsbokzkztsiikazrxqdgtonbqleghxiwfoopcjvrhbdacaeylhnfyjkhcptvqkngkengcntvxqlsurucdxvuylbglmeyynmxreohvojahkyqyowxtlewslgeibjfwgyrjovircbjzllbjibvzjcuktprzuszolftzuxeafvmsfkqqsetgbzrjqovztqyxohzmncroo
67+
example: ovsnvfcwodowljclfphodypoplikvyotjovrjudbmxqvvdlccjyfgdivsjtacjokurmwmxjffismejdaobevyfcbyleqjgqcoefmvdnrazszstfwulwyendppvmxeocdljwpxkslcereqwua
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: 'https://www.rohan.com/quia-aperiam-alias-qui-facere-vitae'
73+
example: 'http://www.smitham.info/consequatur-tempora-aspernatur-officiis-omnis-sed-similique.html'
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: '2087-12-08'
79+
example: '2077-09-25'
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: 9
103+
example: 12
104104
type: integer
105105
queryParameters: []
106106
bodyParameters: []
107107
responses:
108108
-
109109
status: 200
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"}}}'
110+
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"}}}'
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: 14
131+
example: 12
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: 14
153+
example: 12
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: iyvesjvapprtnqekbbuconazxeqwxsdisrbawwoxwbrpoalydexicizlwatouoarqlvu
24+
example: ovsnvfcwodowljclfphodypoplikvyotjovrjudbmxqvvdlccjyfgdivsjtacjokurmwmxjffismejdaobevyfcbyleqjgqcoefmvdnrazszstfwulwyendppvmxeocdljwpxkslcereqwua
2525
type: string
2626
email:
2727
name: email
2828
description: 'Must be a valid email address.'
2929
required: true
30-
example: felipa38@example.net
30+
example: mckayla50@example.net
3131
type: string
3232
password:
3333
name: password
3434
description: ''
3535
required: true
36-
example: soluta
36+
example: error
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: 9
58+
example: 12
5959
type: integer
6060
queryParameters: []
6161
bodyParameters: []
6262
responses:
6363
-
6464
status: 200
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"}]}}'
65+
content: '{"data":{"id":6,"name":"Dr. Kallie Schroeder","email":"boyle.krista@example.com","side_projects":[{"id":10,"name":"similique et et","description":"Odit molestiae non est nostrum sunt.","url":null,"due_at":"20221026","created_at":"2021-06-01T13:45:30.000000Z","updated_at":"2021-06-01T13:45:30.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: 4
140+
example: 12
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: sogdteihlaodtuesxlcjccmumvueaqrzmrjzxagwffmmojyubrekpbmhsbokzkztsiikazrxqdgtonbqleghxiwfoopcjvrhbdacaeylhnfyjkhcptvqkngkengcntvxqlsurucdxvuylbglmeyynmxreohvojahkyqyowxtlewslgeibjfwgyrjovircbjzllbjibvzjcuktprzuszolftzuxeafvmsfkqqsetgbzrjqovztqyxohzmncroo
65+
example: ovsnvfcwodowljclfphodypoplikvyotjovrjudbmxqvvdlccjyfgdivsjtacjokurmwmxjffismejdaobevyfcbyleqjgqcoefmvdnrazszstfwulwyendppvmxeocdljwpxkslcereqwua
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: 'https://www.rohan.com/quia-aperiam-alias-qui-facere-vitae'
71+
example: 'http://www.smitham.info/consequatur-tempora-aspernatur-officiis-omnis-sed-similique.html'
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: '2087-12-08'
77+
example: '2077-09-25'
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: 9
101+
example: 12
102102
type: integer
103103
queryParameters: []
104104
bodyParameters: []
105105
responses:
106106
-
107107
status: 200
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"}}}'
108+
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"}}}'
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: 14
129+
example: 12
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: 14
151+
example: 12
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: iyvesjvapprtnqekbbuconazxeqwxsdisrbawwoxwbrpoalydexicizlwatouoarqlvu
22+
example: ovsnvfcwodowljclfphodypoplikvyotjovrjudbmxqvvdlccjyfgdivsjtacjokurmwmxjffismejdaobevyfcbyleqjgqcoefmvdnrazszstfwulwyendppvmxeocdljwpxkslcereqwua
2323
type: string
2424
email:
2525
name: email
2626
description: 'Must be a valid email address.'
2727
required: true
28-
example: felipa38@example.net
28+
example: mckayla50@example.net
2929
type: string
3030
password:
3131
name: password
3232
description: ''
3333
required: true
34-
example: soluta
34+
example: error
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: 9
56+
example: 12
5757
type: integer
5858
queryParameters: []
5959
bodyParameters: []
6060
responses:
6161
-
6262
status: 200
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"}]}}'
63+
content: '{"data":{"id":6,"name":"Dr. Kallie Schroeder","email":"boyle.krista@example.com","side_projects":[{"id":10,"name":"similique et et","description":"Odit molestiae non est nostrum sunt.","url":null,"due_at":"20221026","created_at":"2021-06-01T13:45:30.000000Z","updated_at":"2021-06-01T13:45:30.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: 4
138+
example: 12
139139
type: integer
140140
queryParameters: []
141141
bodyParameters: []

config/scribe.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@
317317
* If you would like the package to generate the same example values for parameters on each run,
318318
* set this to any number (eg. 1234)
319319
*/
320-
'faker_seed' => null,
320+
'faker_seed' => 9743,
321321

322322
/**
323323
* The strategies Scribe will use to extract information about your routes at each stage.

0 commit comments

Comments
 (0)