Skip to content

Commit 04b3a53

Browse files
shalvahshalvah
committed
Update docs
1 parent d4b65e8 commit 04b3a53

File tree

11 files changed

+230
-222
lines changed

11 files changed

+230
-222
lines changed

‎.scribe/endpoints.cache/1.yaml‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ endpoints:
99
uri: api/side_projects
1010
metadata:
1111
title: 'View all side projects'
12-
description: ''
12+
description: |-
13+
This endpoint's response was gotten via a "response call"—
14+
Scribe called our API in a test environment to get a sample response.
1315
authenticated: false
1416
headers:
1517
Content-Type: application/json
@@ -54,27 +56,27 @@ endpoints:
5456
bodyParameters:
5557
name:
5658
name: name
57-
description: 'The name of your side project. The value must not be greater than 80 characters.'
59+
description: 'The name of your side project. Must not be greater than 80 characters.'
5860
required: true
5961
example: '"The SideProject API"'
6062
type: string
6163
description:
6264
name: description
63-
description: 'A longer description of your side project. The value must not be greater than 255 characters.'
65+
description: 'A longer description of your side project. Must not be greater than 255 characters.'
6466
required: false
65-
example: fgjbfzbzhamascqffkukusyxpfhhnexibriqgoylogtkynblcsjszzfmuiyixsoborxcppjuwtwugoxonwehwavbbmbycmufnnqlatfoqoxlylkouuojexovacalpbjnuwnmbcbgnwqidmlgcgplkzzbf
67+
example: kcgbeadgobhbdzlccwnzamesuompttmeksqctgdbrgynrertjhyookslffnsjuzlbrguogyiqxobvcvxblxayzwpwjznwllyluleza
6668
type: string
6769
url:
6870
name: url
69-
description: 'A url to your side project. The value must be a valid URL.'
71+
description: 'A url to your side project. Must be a valid URL.'
7072
required: false
71-
example: 'http://www.bayer.org/architecto-laudantium-perferendis-doloribus-sint'
73+
example: 'http://daniel.org/rerum-reiciendis-eum-est-quia-ut-culpa'
7274
type: string
7375
due_at:
7476
name: due_at
75-
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>.'
77+
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>.'
7678
required: false
77-
example: '2112-08-03'
79+
example: '2046-05-03'
7880
type: string
7981
responses: []
8082
responseFields: []
@@ -98,14 +100,14 @@ endpoints:
98100
name: id
99101
description: 'The ID of the side project.'
100102
required: true
101-
example: 5
103+
example: 12
102104
type: integer
103105
queryParameters: []
104106
bodyParameters: []
105107
responses:
106108
-
107109
status: 200
108-
content: '{"data":{"name":"omnis facere quia","description":"Porro atque exercitationem aspernatur doloribus reiciendis quo repellendus.","due_date":"20280807","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":"ducimus voluptatum officia","description":"Explicabo voluptatem voluptas autem illo cumque.","due_date":"20210805","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"}}}'
109111
headers: []
110112
description: null
111113
responseFields: []
@@ -126,7 +128,7 @@ endpoints:
126128
name: id
127129
description: 'The ID of the side project.'
128130
required: true
129-
example: 4
131+
example: 2
130132
type: integer
131133
queryParameters: []
132134
bodyParameters: []

‎.scribe/endpoints.cache/2.yaml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,21 @@ endpoints:
1919
bodyParameters:
2020
name:
2121
name: name
22-
description: 'The value must be at least 1 characters. The value must not be greater than 255 characters.'
22+
description: 'Must be at least 1 characters. Must not be greater than 255 characters.'
2323
required: true
24-
example: meinzggvhunivpobtwkftopruribdemrysmmuudebsbyazghwgwjlslewevcvocfftaryqiuqxlfbbyguukraxzd
24+
example: trqnxnemrkljkswgqtwrrmyeaigaohgzdqlmdxokxycgxzzkkwrnrjrvcxznvzmzxacdqwmrgpucbadfqzyzcoytogorigungqtkccunhmzscorjznbsucktstxyimtkducqrvgoprupzbxlxcotjbosqpgkhepmopdbtpjuwzzkhcparqhqbdymgtijxblnnmngptcfghxlplimlbbvahrzdxbho
2525
type: string
2626
email:
2727
name: email
28-
description: 'The value must be a valid email address.'
28+
description: 'Must be a valid email address.'
2929
required: true
30-
example: shanahan.bridie@example.net
30+
example: toconner@example.net
3131
type: string
3232
password:
3333
name: password
3434
description: ''
3535
required: true
36-
example: magni
36+
example: est
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: 4
58+
example: 7
5959
type: integer
6060
queryParameters: []
6161
bodyParameters: []
6262
responses:
6363
-
6464
status: 200
65-
content: '{"data":{"id":6,"name":"Maximillia Stracke","email":"schaefer.marielle@example.net","side_projects":[{"id":10,"name":"et eaque in","description":"Error et mollitia pariatur enim.","url":null,"due_at":"20281002","created_at":"2021-05-30T01:04:25.000000Z","updated_at":"2021-05-30T01:04:25.000000Z","user_id":"6"}]}}'
65+
content: '{"data":{"id":6,"name":"Chaya Schinner","email":"itorp@example.net","side_projects":[{"id":10,"name":"a sed nulla","description":"Illo ipsa alias tempore modi exercitationem molestias animi non.","url":null,"due_at":"20240525","created_at":"2021-05-31T11:55:44.000000Z","updated_at":"2021-05-31T11:55:44.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: 14
140+
example: 10
141141
type: integer
142142
queryParameters: []
143143
bodyParameters: []

‎.scribe/endpoints/1.yaml‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ endpoints:
77
uri: api/side_projects
88
metadata:
99
title: 'View all side projects'
10-
description: ''
10+
description: |-
11+
This endpoint's response was gotten via a "response call"—
12+
Scribe called our API in a test environment to get a sample response.
1113
authenticated: false
1214
headers:
1315
Content-Type: application/json
@@ -52,27 +54,27 @@ endpoints:
5254
bodyParameters:
5355
name:
5456
name: name
55-
description: 'The name of your side project. The value must not be greater than 80 characters.'
57+
description: 'The name of your side project. Must not be greater than 80 characters.'
5658
required: true
5759
example: '"The SideProject API"'
5860
type: string
5961
description:
6062
name: description
61-
description: 'A longer description of your side project. The value must not be greater than 255 characters.'
63+
description: 'A longer description of your side project. Must not be greater than 255 characters.'
6264
required: false
63-
example: fgjbfzbzhamascqffkukusyxpfhhnexibriqgoylogtkynblcsjszzfmuiyixsoborxcppjuwtwugoxonwehwavbbmbycmufnnqlatfoqoxlylkouuojexovacalpbjnuwnmbcbgnwqidmlgcgplkzzbf
65+
example: kcgbeadgobhbdzlccwnzamesuompttmeksqctgdbrgynrertjhyookslffnsjuzlbrguogyiqxobvcvxblxayzwpwjznwllyluleza
6466
type: string
6567
url:
6668
name: url
67-
description: 'A url to your side project. The value must be a valid URL.'
69+
description: 'A url to your side project. Must be a valid URL.'
6870
required: false
69-
example: 'http://www.bayer.org/architecto-laudantium-perferendis-doloribus-sint'
71+
example: 'http://daniel.org/rerum-reiciendis-eum-est-quia-ut-culpa'
7072
type: string
7173
due_at:
7274
name: due_at
73-
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>.'
75+
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>.'
7476
required: false
75-
example: '2112-08-03'
77+
example: '2046-05-03'
7678
type: string
7779
responses: []
7880
responseFields: []
@@ -96,14 +98,14 @@ endpoints:
9698
name: id
9799
description: 'The ID of the side project.'
98100
required: true
99-
example: 5
101+
example: 12
100102
type: integer
101103
queryParameters: []
102104
bodyParameters: []
103105
responses:
104106
-
105107
status: 200
106-
content: '{"data":{"name":"omnis facere quia","description":"Porro atque exercitationem aspernatur doloribus reiciendis quo repellendus.","due_date":"20280807","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":"ducimus voluptatum officia","description":"Explicabo voluptatem voluptas autem illo cumque.","due_date":"20210805","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"}}}'
107109
headers: []
108110
description: null
109111
responseFields: []
@@ -124,7 +126,7 @@ endpoints:
124126
name: id
125127
description: 'The ID of the side project.'
126128
required: true
127-
example: 4
129+
example: 2
128130
type: integer
129131
queryParameters: []
130132
bodyParameters: []

‎.scribe/endpoints/2.yaml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,21 @@ endpoints:
1717
bodyParameters:
1818
name:
1919
name: name
20-
description: 'The value must be at least 1 characters. The value must not be greater than 255 characters.'
20+
description: 'Must be at least 1 characters. Must not be greater than 255 characters.'
2121
required: true
22-
example: meinzggvhunivpobtwkftopruribdemrysmmuudebsbyazghwgwjlslewevcvocfftaryqiuqxlfbbyguukraxzd
22+
example: trqnxnemrkljkswgqtwrrmyeaigaohgzdqlmdxokxycgxzzkkwrnrjrvcxznvzmzxacdqwmrgpucbadfqzyzcoytogorigungqtkccunhmzscorjznbsucktstxyimtkducqrvgoprupzbxlxcotjbosqpgkhepmopdbtpjuwzzkhcparqhqbdymgtijxblnnmngptcfghxlplimlbbvahrzdxbho
2323
type: string
2424
email:
2525
name: email
26-
description: 'The value must be a valid email address.'
26+
description: 'Must be a valid email address.'
2727
required: true
28-
example: shanahan.bridie@example.net
28+
example: toconner@example.net
2929
type: string
3030
password:
3131
name: password
3232
description: ''
3333
required: true
34-
example: magni
34+
example: est
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: 4
56+
example: 7
5757
type: integer
5858
queryParameters: []
5959
bodyParameters: []
6060
responses:
6161
-
6262
status: 200
63-
content: '{"data":{"id":6,"name":"Maximillia Stracke","email":"schaefer.marielle@example.net","side_projects":[{"id":10,"name":"et eaque in","description":"Error et mollitia pariatur enim.","url":null,"due_at":"20281002","created_at":"2021-05-30T01:04:25.000000Z","updated_at":"2021-05-30T01:04:25.000000Z","user_id":"6"}]}}'
63+
content: '{"data":{"id":6,"name":"Chaya Schinner","email":"itorp@example.net","side_projects":[{"id":10,"name":"a sed nulla","description":"Illo ipsa alias tempore modi exercitationem molestias animi non.","url":null,"due_at":"20240525","created_at":"2021-05-31T11:55:44.000000Z","updated_at":"2021-05-31T11:55:44.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: 14
138+
example: 10
139139
type: integer
140140
queryParameters: []
141141
bodyParameters: []

‎app/Http/Controllers/SideProjectController.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ public function __construct()
2121
/**
2222
* View all side projects
2323
*
24+
* This endpoint's response was gotten via a "response call"—
25+
* Scribe called our API in a test environment to get a sample response.
2426
*/
2527
public function index()
2628
{

‎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": "de7b7ed1-7aa4-44d8-884b-9ac7a3b0386d",
13+
"_postman_id": "54da91e8-91a3-46cf-b713-7c7112a30f76",
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
},
@@ -102,7 +102,7 @@
102102
}
103103
],
104104
"body": null,
105-
"description": "",
105+
"description": "This endpoint's response was gotten via a \"response call\"\u2014\nScribe called our API in a test environment to get a sample response.",
106106
"auth": {
107107
"type": "noauth"
108108
}
@@ -156,7 +156,7 @@
156156
],
157157
"body": {
158158
"mode": "raw",
159-
"raw": "{\"name\":\"\\\"The SideProject API\\\"\",\"description\":\"fgjbfzbzhamascqffkukusyxpfhhnexibriqgoylogtkynblcsjszzfmuiyixsoborxcppjuwtwugoxonwehwavbbmbycmufnnqlatfoqoxlylkouuojexovacalpbjnuwnmbcbgnwqidmlgcgplkzzbf\",\"url\":\"http:\\\/\\\/www.bayer.org\\\/architecto-laudantium-perferendis-doloribus-sint\",\"due_at\":\"2112-08-03\"}"
159+
"raw": "{\"name\":\"\\\"The SideProject API\\\"\",\"description\":\"kcgbeadgobhbdzlccwnzamesuompttmeksqctgdbrgynrertjhyookslffnsjuzlbrguogyiqxobvcvxblxayzwpwjznwllyluleza\",\"url\":\"http:\\\/\\\/daniel.org\\\/rerum-reiciendis-eum-est-quia-ut-culpa\",\"due_at\":\"2046-05-03\"}"
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": "5",
178+
"value": "12",
179179
"description": "The ID of the side project."
180180
}
181181
]
@@ -197,7 +197,7 @@
197197
{
198198
"header": [],
199199
"code": 200,
200-
"body": "{\"data\":{\"name\":\"omnis facere quia\",\"description\":\"Porro atque exercitationem aspernatur doloribus reiciendis quo repellendus.\",\"due_date\":\"20280807\",\"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\":\"ducimus voluptatum officia\",\"description\":\"Explicabo voluptatem voluptas autem illo cumque.\",\"due_date\":\"20210805\",\"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": "4",
218+
"value": "2",
219219
"description": "The ID of the side project."
220220
}
221221
]
@@ -293,7 +293,7 @@
293293
],
294294
"body": {
295295
"mode": "raw",
296-
"raw": "{\"name\":\"meinzggvhunivpobtwkftopruribdemrysmmuudebsbyazghwgwjlslewevcvocfftaryqiuqxlfbbyguukraxzd\",\"email\":\"shanahan.bridie@example.net\",\"password\":\"magni\"}"
296+
"raw": "{\"name\":\"trqnxnemrkljkswgqtwrrmyeaigaohgzdqlmdxokxycgxzzkkwrnrjrvcxznvzmzxacdqwmrgpucbadfqzyzcoytogorigungqtkccunhmzscorjznbsucktstxyimtkducqrvgoprupzbxlxcotjbosqpgkhepmopdbtpjuwzzkhcparqhqbdymgtijxblnnmngptcfghxlplimlbbvahrzdxbho\",\"email\":\"toconner@example.net\",\"password\":\"est\"}"
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": "4",
318+
"value": "7",
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\":\"Maximillia Stracke\",\"email\":\"schaefer.marielle@example.net\",\"side_projects\":[{\"id\":10,\"name\":\"et eaque in\",\"description\":\"Error et mollitia pariatur enim.\",\"url\":null,\"due_at\":\"20281002\",\"created_at\":\"2021-05-30T01:04:25.000000Z\",\"updated_at\":\"2021-05-30T01:04:25.000000Z\",\"user_id\":\"6\"}]}}",
340+
"body": "{\"data\":{\"id\":6,\"name\":\"Chaya Schinner\",\"email\":\"itorp@example.net\",\"side_projects\":[{\"id\":10,\"name\":\"a sed nulla\",\"description\":\"Illo ipsa alias tempore modi exercitationem molestias animi non.\",\"url\":null,\"due_at\":\"20240525\",\"created_at\":\"2021-05-31T11:55:44.000000Z\",\"updated_at\":\"2021-05-31T11:55:44.000000Z\",\"user_id\":\"6\"}]}}",
341341
"name": null
342342
},
343343
{
@@ -427,7 +427,7 @@
427427
{
428428
"id": "id",
429429
"key": "id",
430-
"value": "14",
430+
"value": "10",
431431
"description": "The ID of the user."
432432
}
433433
]

0 commit comments

Comments
 (0)