Skip to content

Commit 18ecdb4

Browse files
committed
installed scribe
1 parent 1c119d8 commit 18ecdb4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+6015
-1064
lines changed

frameworks-laravel/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
/.fleet
99
/.idea
1010
/.nova
11+
/.scribe
1112
/.phpunit.cache
1213
/.vscode
1314
/.zed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# GENERATED. YOU SHOULDN'T MODIFY OR DELETE THIS FILE.
2+
# Scribe uses this file to know when you change something manually in your docs.
3+
.scribe/intro.md=35310953ddf7f9e68771f7ed7b6189f9
4+
.scribe/auth.md=9bee2b1ef8a238b2e58613fa636d5f39

frameworks-laravel/.scribe/auth.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Authenticating requests
2+
3+
This API is not authenticated.
Lines changed: 321 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,321 @@
1+
## Autogenerated by Scribe. DO NOT MODIFY.
2+
3+
name: Endpoints
4+
description: ''
5+
endpoints:
6+
-
7+
custom: []
8+
httpMethods:
9+
- GET
10+
uri: api/health
11+
metadata:
12+
custom: []
13+
groupName: Endpoints
14+
groupDescription: ''
15+
subgroup: ''
16+
subgroupDescription: ''
17+
title: ''
18+
description: ''
19+
authenticated: false
20+
deprecated: false
21+
headers:
22+
Content-Type: application/json
23+
Accept: application/json
24+
urlParameters: []
25+
cleanUrlParameters: []
26+
queryParameters: []
27+
cleanQueryParameters: []
28+
bodyParameters: []
29+
cleanBodyParameters: []
30+
fileParameters: []
31+
responses:
32+
-
33+
custom: []
34+
status: 200
35+
content: '{"status":"healthy","version":"unversioned","timestamp":"2025-11-03T10:55:55+00:00"}'
36+
headers:
37+
cache-control: 'no-cache, private'
38+
content-type: application/json
39+
access-control-allow-origin: '*'
40+
description: null
41+
responseFields: []
42+
auth: []
43+
controller: null
44+
method: null
45+
route: null
46+
-
47+
custom: []
48+
httpMethods:
49+
- GET
50+
uri: api/drivers
51+
metadata:
52+
custom: []
53+
groupName: Endpoints
54+
groupDescription: ''
55+
subgroup: ''
56+
subgroupDescription: ''
57+
title: 'Display a listing of the resource.'
58+
description: ''
59+
authenticated: false
60+
deprecated: false
61+
headers:
62+
Content-Type: application/json
63+
Accept: application/json
64+
urlParameters: []
65+
cleanUrlParameters: []
66+
queryParameters: []
67+
cleanQueryParameters: []
68+
bodyParameters: []
69+
cleanBodyParameters: []
70+
fileParameters: []
71+
responses:
72+
-
73+
custom: []
74+
status: 200
75+
content: '{"data":[{"id":1,"name":"Max Verstappen","code":"VER","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":2,"name":"Sergio Perez","code":"PER","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":3,"name":"Lewis Hamilton","code":"HAM","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":4,"name":"George Russell","code":"RUS","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":5,"name":"Charles Leclerc","code":"LEC","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":6,"name":"Carlos Sainz","code":"SAI","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":7,"name":"Lando Norris","code":"NOR","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":8,"name":"Oscar Piastri","code":"PIA","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":9,"name":"Fernando Alonso","code":"ALO","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":10,"name":"Lance Stroll","code":"STR","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"}],"meta":{"count":10}}'
76+
headers:
77+
cache-control: 'no-cache, private'
78+
content-type: application/json
79+
access-control-allow-origin: '*'
80+
description: null
81+
responseFields: []
82+
auth: []
83+
controller: null
84+
method: null
85+
route: null
86+
-
87+
custom: []
88+
httpMethods:
89+
- GET
90+
uri: 'api/drivers/{id}'
91+
metadata:
92+
custom: []
93+
groupName: Endpoints
94+
groupDescription: ''
95+
subgroup: ''
96+
subgroupDescription: ''
97+
title: 'Display the specified resource.'
98+
description: ''
99+
authenticated: false
100+
deprecated: false
101+
headers:
102+
Content-Type: application/json
103+
Accept: application/json
104+
urlParameters:
105+
id:
106+
custom: []
107+
name: id
108+
description: 'The ID of the driver.'
109+
required: true
110+
example: 1
111+
type: integer
112+
enumValues: []
113+
exampleWasSpecified: false
114+
nullable: false
115+
deprecated: false
116+
cleanUrlParameters:
117+
id: 1
118+
queryParameters: []
119+
cleanQueryParameters: []
120+
bodyParameters: []
121+
cleanBodyParameters: []
122+
fileParameters: []
123+
responses:
124+
-
125+
custom: []
126+
status: 200
127+
content: '{"data":{"id":1,"name":"Max Verstappen","code":"VER","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"}}'
128+
headers:
129+
cache-control: 'no-cache, private'
130+
content-type: application/json
131+
access-control-allow-origin: '*'
132+
description: null
133+
responseFields: []
134+
auth: []
135+
controller: null
136+
method: null
137+
route: null
138+
-
139+
custom: []
140+
httpMethods:
141+
- GET
142+
uri: api/circuits
143+
metadata:
144+
custom: []
145+
groupName: Endpoints
146+
groupDescription: ''
147+
subgroup: ''
148+
subgroupDescription: ''
149+
title: 'Display a listing of the resource.'
150+
description: ''
151+
authenticated: false
152+
deprecated: false
153+
headers:
154+
Content-Type: application/json
155+
Accept: application/json
156+
urlParameters: []
157+
cleanUrlParameters: []
158+
queryParameters: []
159+
cleanQueryParameters: []
160+
bodyParameters: []
161+
cleanBodyParameters: []
162+
fileParameters: []
163+
responses:
164+
-
165+
custom: []
166+
status: 200
167+
content: '{"data":[{"id":1,"name":"Monaco Grand Prix","location":"Monte Carlo, Monaco","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":2,"name":"British Grand Prix","location":"Silverstone, United Kingdom","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":3,"name":"Italian Grand Prix","location":"Monza, Italy","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":4,"name":"Belgian Grand Prix","location":"Spa-Francorchamps, Belgium","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":5,"name":"Japanese Grand Prix","location":"Suzuka, Japan","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":6,"name":"Singapore Grand Prix","location":"Marina Bay, Singapore","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":7,"name":"Abu Dhabi Grand Prix","location":"Yas Marina, UAE","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":8,"name":"Brazilian Grand Prix","location":"Interlagos, Brazil","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":9,"name":"Australian Grand Prix","location":"Melbourne, Australia","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"},{"id":10,"name":"Spanish Grand Prix","location":"Barcelona, Spain","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"}],"meta":{"count":10}}'
168+
headers:
169+
cache-control: 'no-cache, private'
170+
content-type: application/json
171+
access-control-allow-origin: '*'
172+
description: null
173+
responseFields: []
174+
auth: []
175+
controller: null
176+
method: null
177+
route: null
178+
-
179+
custom: []
180+
httpMethods:
181+
- GET
182+
uri: 'api/circuits/{id}'
183+
metadata:
184+
custom: []
185+
groupName: Endpoints
186+
groupDescription: ''
187+
subgroup: ''
188+
subgroupDescription: ''
189+
title: 'Display the specified resource.'
190+
description: ''
191+
authenticated: false
192+
deprecated: false
193+
headers:
194+
Content-Type: application/json
195+
Accept: application/json
196+
urlParameters:
197+
id:
198+
custom: []
199+
name: id
200+
description: 'The ID of the circuit.'
201+
required: true
202+
example: 1
203+
type: integer
204+
enumValues: []
205+
exampleWasSpecified: false
206+
nullable: false
207+
deprecated: false
208+
cleanUrlParameters:
209+
id: 1
210+
queryParameters: []
211+
cleanQueryParameters: []
212+
bodyParameters: []
213+
cleanBodyParameters: []
214+
fileParameters: []
215+
responses:
216+
-
217+
custom: []
218+
status: 200
219+
content: '{"data":{"id":1,"name":"Monaco Grand Prix","location":"Monte Carlo, Monaco","created_at":"2025-10-29T17:21:39.000000Z","updated_at":"2025-10-29T17:21:39.000000Z"}}'
220+
headers:
221+
cache-control: 'no-cache, private'
222+
content-type: application/json
223+
access-control-allow-origin: '*'
224+
description: null
225+
responseFields: []
226+
auth: []
227+
controller: null
228+
method: null
229+
route: null
230+
-
231+
custom: []
232+
httpMethods:
233+
- GET
234+
uri: api/races
235+
metadata:
236+
custom: []
237+
groupName: Endpoints
238+
groupDescription: ''
239+
subgroup: ''
240+
subgroupDescription: ''
241+
title: 'Display a listing of the resource.'
242+
description: ''
243+
authenticated: false
244+
deprecated: false
245+
headers:
246+
Content-Type: application/json
247+
Accept: application/json
248+
urlParameters: []
249+
cleanUrlParameters: []
250+
queryParameters: []
251+
cleanQueryParameters: []
252+
bodyParameters: []
253+
cleanBodyParameters: []
254+
fileParameters: []
255+
responses:
256+
-
257+
custom: []
258+
status: 200
259+
content: '{"data":[{"id":1,"name":"2024 Monaco Grand Prix","race_date":"2024-05-26","season":"2024","created_at":"2025-10-29T17:21:39+00:00","updated_at":"2025-10-29T17:21:39+00:00","links":{"self":"http:\/\/localhost\/api\/races\/1","circuit":"http:\/\/localhost\/api\/circuits\/1","drivers":"http:\/\/localhost\/api\/drivers?race=1"}},{"id":2,"name":"2024 British Grand Prix","race_date":"2024-07-07","season":"2024","created_at":"2025-10-29T17:21:39+00:00","updated_at":"2025-10-29T17:21:39+00:00","links":{"self":"http:\/\/localhost\/api\/races\/2","circuit":"http:\/\/localhost\/api\/circuits\/2","drivers":"http:\/\/localhost\/api\/drivers?race=2"}},{"id":3,"name":"2024 Italian Grand Prix","race_date":"2024-09-01","season":"2024","created_at":"2025-10-29T17:21:39+00:00","updated_at":"2025-10-29T17:21:39+00:00","links":{"self":"http:\/\/localhost\/api\/races\/3","circuit":"http:\/\/localhost\/api\/circuits\/3","drivers":"http:\/\/localhost\/api\/drivers?race=3"}},{"id":4,"name":"2024 Belgian Grand Prix","race_date":"2024-07-28","season":"2024","created_at":"2025-10-29T17:21:39+00:00","updated_at":"2025-10-29T17:21:39+00:00","links":{"self":"http:\/\/localhost\/api\/races\/4","circuit":"http:\/\/localhost\/api\/circuits\/4","drivers":"http:\/\/localhost\/api\/drivers?race=4"}},{"id":5,"name":"2024 Japanese Grand Prix","race_date":"2024-04-07","season":"2024","created_at":"2025-10-29T17:21:40+00:00","updated_at":"2025-10-29T17:21:40+00:00","links":{"self":"http:\/\/localhost\/api\/races\/5","circuit":"http:\/\/localhost\/api\/circuits\/5","drivers":"http:\/\/localhost\/api\/drivers?race=5"}}],"meta":{"count":5}}'
260+
headers:
261+
cache-control: 'no-cache, private'
262+
content-type: application/json
263+
access-control-allow-origin: '*'
264+
description: null
265+
responseFields: []
266+
auth: []
267+
controller: null
268+
method: null
269+
route: null
270+
-
271+
custom: []
272+
httpMethods:
273+
- GET
274+
uri: 'api/races/{id}'
275+
metadata:
276+
custom: []
277+
groupName: Endpoints
278+
groupDescription: ''
279+
subgroup: ''
280+
subgroupDescription: ''
281+
title: 'Display the specified resource.'
282+
description: ''
283+
authenticated: false
284+
deprecated: false
285+
headers:
286+
Content-Type: application/json
287+
Accept: application/json
288+
urlParameters:
289+
id:
290+
custom: []
291+
name: id
292+
description: 'The ID of the race.'
293+
required: true
294+
example: 1
295+
type: integer
296+
enumValues: []
297+
exampleWasSpecified: false
298+
nullable: false
299+
deprecated: false
300+
cleanUrlParameters:
301+
id: 1
302+
queryParameters: []
303+
cleanQueryParameters: []
304+
bodyParameters: []
305+
cleanBodyParameters: []
306+
fileParameters: []
307+
responses:
308+
-
309+
custom: []
310+
status: 200
311+
content: '{"data":{"id":1,"name":"2024 Monaco Grand Prix","race_date":"2024-05-26","season":"2024","created_at":"2025-10-29T17:21:39+00:00","updated_at":"2025-10-29T17:21:39+00:00","links":{"self":"http:\/\/localhost\/api\/races\/1","circuit":"http:\/\/localhost\/api\/circuits\/1","drivers":"http:\/\/localhost\/api\/drivers?race=1"}}}'
312+
headers:
313+
cache-control: 'no-cache, private'
314+
content-type: application/json
315+
access-control-allow-origin: '*'
316+
description: null
317+
responseFields: []
318+
auth: []
319+
controller: null
320+
method: null
321+
route: null

0 commit comments

Comments
 (0)