Skip to content

Commit

Permalink
Upgrade to Laravel 9; update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shalvah committed Dec 25, 2023
1 parent 45bea28 commit 52771ed
Show file tree
Hide file tree
Showing 28 changed files with 4,000 additions and 7,313 deletions.
20 changes: 13 additions & 7 deletions .scribe-alternate/endpoints.cache/00.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ endpoints:
required: false
example: et
type: string
enumValues: []
exampleWasSpecified: false
custom: []
cleanUrlParameters:
unnecessaryParam: et
Expand All @@ -38,37 +40,41 @@ endpoints:
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 400
content: '{"status": "down", "services": {"database": "up", "redis": "down"}}'
headers: []
description: '400, Service is unhealthy'
custom: []
-
status: 200
content: '{"status":"up","services":{"database":"up","redis":"up"}}'
headers:
cache-control: 'no-cache, private'
content-type: application/json
x-ratelimit-limit: '60'
x-ratelimit-remaining: '55'
x-ratelimit-remaining: '47'
access-control-allow-origin: '*'
description: null
custom: []
-
status: 400
content: '{"status": "down", "services": {"database": "up", "redis": "down"}}'
headers: []
description: 'Service is unhealthy'
custom: []
responseFields:
status:
name: status
description: 'The status of this API (`up` or `down`).'
required: false
example: null
type: string
enumValues: []
exampleWasSpecified: false
custom: []
services:
name: services
description: 'Map of each downstream service and their status (`up` or `down`).'
required: false
example: null
type: object
enumValues: []
exampleWasSpecified: false
custom: []
auth: []
controller: null
Expand Down
66 changes: 43 additions & 23 deletions .scribe-alternate/endpoints.cache/01.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,29 +26,35 @@ endpoints:
bodyParameters:
name:
name: name
description: 'Must be at least 1 characters. Must not be greater than 255 characters.'
description: 'Must be at least 1 character. Must not be greater than 255 characters.'
required: true
example: pidsgyfhasfdpmrgozmxiqtrcoqjruexeugqpersioudgkpsbnkltlaqvmwjyiahevihxmbowbowymkwgcqxiqmrchyclplgrcipefeeopzzxuuljqvytlucrlnslwwcdxrknhwrlmabpwubvoetriefhfwzv
example: pidsgyfhasfdpmrg
type: string
enumValues: []
exampleWasSpecified: false
custom: []
email:
name: email
description: 'Must be a valid email address.'
required: true
example: casimir70@example.com
example: julianne89@example.com
type: string
enumValues: []
exampleWasSpecified: false
custom: []
password:
name: password
description: ''
required: true
example: et
example: '@.b8z4="e5,ZNa6'
type: string
enumValues: []
exampleWasSpecified: false
custom: []
cleanBodyParameters:
name: pidsgyfhasfdpmrgozmxiqtrcoqjruexeugqpersioudgkpsbnkltlaqvmwjyiahevihxmbowbowymkwgcqxiqmrchyclplgrcipefeeopzzxuuljqvytlucrlnslwwcdxrknhwrlmabpwubvoetriefhfwzv
email: casimir70@example.com
password: et
name: pidsgyfhasfdpmrg
email: julianne89@example.com
password: '@.b8z4="e5,ZNa6'
fileParameters: []
responses: []
responseFields: []
Expand Down Expand Up @@ -80,28 +86,30 @@ endpoints:
name: id
description: 'The ID of the user.'
required: true
example: 1
type: integer
example: et
type: string
enumValues: []
exampleWasSpecified: false
custom: []
cleanUrlParameters:
id: 1
id: et
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 404
content: '{"message":"Not found","resource":"user"}'
status: 200
content: '{"data":{"id":1,"name":"Mr. Merlin Friesen","email":"[email protected]","side_projects":[{"id":1,"name":"est numquam consequuntur","description":"Atque nobis ut natus aut dolores eveniet.","url":null,"due_at":20270327,"created_at":"2023-12-13T23:29:24.000000Z","updated_at":"2023-12-13T23:29:24.000000Z","user_id":1}]}}'
headers: []
description: '404, User not found'
description: ''
custom: []
-
status: 200
content: '{"data":{"id":6,"name":"Mr. Merlin Friesen","email":"[email protected]","side_projects":[{"id":10,"name":"est numquam consequuntur","description":"Atque nobis ut natus aut dolores eveniet.","url":null,"due_at":20251222,"created_at":"2022-09-10T02:22:37.000000Z","updated_at":"2022-09-10T02:22:37.000000Z","user_id":6}]}}'
status: 404
content: '{"message":"Not found","resource":"user"}'
headers: []
description: ''
description: '404, User not found'
custom: []
responseFields: []
auth: []
Expand Down Expand Up @@ -138,13 +146,17 @@ endpoints:
required: false
example: 1
type: string
enumValues: []
exampleWasSpecified: false
custom: []
pageSize:
name: pageSize
description: 'Number of items to return in a page. Defaults to 10. This parameter was added by a custom strategy.'
required: false
example: null
type: string
enumValues: []
exampleWasSpecified: false
custom: []
cleanQueryParameters:
page: 1
Expand All @@ -154,12 +166,12 @@ endpoints:
responses:
-
status: 200
content: '{"data":[{"id":1,"name":"Pete","email":"[email protected]","side_projects":[{"id":2,"name":"iusto ut dolor","description":"Voluptatem aspernatur dolorem quae quaerat harum.","url":null,"due_at":20301215,"created_at":"2021-05-30T00:21:59.000000Z","updated_at":"2021-05-30T00:21:59.000000Z","user_id":1},{"id":4,"name":"corporis consequuntur amet","description":"Dolores eveniet deleniti voluptatem saepe expedita.","url":null,"due_at":20230712,"created_at":"2021-05-30T00:23:25.000000Z","updated_at":"2021-05-30T00:23:25.000000Z","user_id":1},{"id":6,"name":"nihil voluptate quaerat","description":"Animi reprehenderit soluta id quo.","url":null,"due_at":20290603,"created_at":"2021-05-30T00:24:27.000000Z","updated_at":"2021-05-30T00:24:27.000000Z","user_id":1},{"id":8,"name":"vel perspiciatis quo","description":"Et qui praesentium consequatur distinctio natus.","url":null,"due_at":20210605,"created_at":"2021-05-30T00:25:43.000000Z","updated_at":"2021-05-30T00:25:43.000000Z","user_id":1},{"id":9,"name":"qui et totam","description":"Veritatis quo dolorum soluta ut.","url":null,"due_at":20270203,"created_at":"2021-05-30T00:25:43.000000Z","updated_at":"2021-05-30T00:25:43.000000Z","user_id":1}]},{"id":2,"name":"Alexane Weber","email":"[email protected]","side_projects":[{"id":1,"name":"voluptas assumenda maiores","description":"Consequuntur aut ea est non.","url":null,"due_at":20310222,"created_at":"2021-05-30T00:21:59.000000Z","updated_at":"2021-05-30T00:21:59.000000Z","user_id":2}]},{"id":3,"name":"John Kshlerin II","email":"[email protected]","side_projects":[{"id":3,"name":"provident et consequatur","description":"Quos et ipsum cum pariatur ex perspiciatis eius.","url":null,"due_at":20231022,"created_at":"2021-05-30T00:23:25.000000Z","updated_at":"2021-05-30T00:23:25.000000Z","user_id":3}]},{"id":4,"name":"Rebeca Morissette","email":"[email protected]","side_projects":[{"id":5,"name":"optio excepturi ea","description":"Error deleniti sint a nostrum consequuntur et.","url":null,"due_at":20260324,"created_at":"2021-05-30T00:24:27.000000Z","updated_at":"2021-05-30T00:24:27.000000Z","user_id":4}]},{"id":5,"name":"Prof. Adah Witting IV","email":"[email protected]","side_projects":[{"id":7,"name":"aspernatur architecto assumenda","description":"Nisi ea aut vel sint vero voluptas tempore.","url":null,"due_at":20280710,"created_at":"2021-05-30T00:25:43.000000Z","updated_at":"2021-05-30T00:25:43.000000Z","user_id":5}]}]}'
content: '{"data":[]}'
headers:
cache-control: 'no-cache, private'
content-type: application/json
x-ratelimit-limit: '60'
x-ratelimit-remaining: '54'
x-ratelimit-remaining: '46'
access-control-allow-origin: '*'
description: null
custom: []
Expand Down Expand Up @@ -190,18 +202,22 @@ endpoints:
name: id
description: 'The ID of the user.'
required: true
example: 1
example: 13
type: integer
enumValues: []
exampleWasSpecified: false
custom: []
cleanUrlParameters:
id: 1
id: 13
queryParameters:
confirm:
name: confirm
description: 'A really silly parameter'
required: false
example: 'true'
type: string
enumValues: []
exampleWasSpecified: false
custom: []
cleanQueryParameters:
confirm: 'true'
Expand Down Expand Up @@ -245,11 +261,13 @@ endpoints:
name: id
description: 'The ID of the user.'
required: true
example: 1
example: 13
type: integer
enumValues: []
exampleWasSpecified: false
custom: []
cleanUrlParameters:
id: 1
id: 13
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
Expand All @@ -266,9 +284,11 @@ endpoints:
token:
name: token
description: 'The new API token. Valid forever.'
required: false
required: true
example: null
type: string
enumValues: []
exampleWasSpecified: false
custom: []
auth: []
controller: null
Expand Down
48 changes: 32 additions & 16 deletions .scribe-alternate/endpoints.cache/02.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ endpoints:
responses:
-
status: 200
content: '[{"id":1,"name":"voluptas assumenda maiores","description":"Consequuntur aut ea est non.","url":null,"due_at":20310222,"created_at":"2021-05-30T00:21:59.000000Z","updated_at":"2021-05-30T00:21:59.000000Z","user_id":2},{"id":2,"name":"iusto ut dolor","description":"Voluptatem aspernatur dolorem quae quaerat harum.","url":null,"due_at":20301215,"created_at":"2021-05-30T00:21:59.000000Z","updated_at":"2021-05-30T00:21:59.000000Z","user_id":1},{"id":3,"name":"provident et consequatur","description":"Quos et ipsum cum pariatur ex perspiciatis eius.","url":null,"due_at":20231022,"created_at":"2021-05-30T00:23:25.000000Z","updated_at":"2021-05-30T00:23:25.000000Z","user_id":3},{"id":4,"name":"corporis consequuntur amet","description":"Dolores eveniet deleniti voluptatem saepe expedita.","url":null,"due_at":20230712,"created_at":"2021-05-30T00:23:25.000000Z","updated_at":"2021-05-30T00:23:25.000000Z","user_id":1},{"id":5,"name":"optio excepturi ea","description":"Error deleniti sint a nostrum consequuntur et.","url":null,"due_at":20260324,"created_at":"2021-05-30T00:24:27.000000Z","updated_at":"2021-05-30T00:24:27.000000Z","user_id":4},{"id":6,"name":"nihil voluptate quaerat","description":"Animi reprehenderit soluta id quo.","url":null,"due_at":20290603,"created_at":"2021-05-30T00:24:27.000000Z","updated_at":"2021-05-30T00:24:27.000000Z","user_id":1},{"id":7,"name":"aspernatur architecto assumenda","description":"Nisi ea aut vel sint vero voluptas tempore.","url":null,"due_at":20280710,"created_at":"2021-05-30T00:25:43.000000Z","updated_at":"2021-05-30T00:25:43.000000Z","user_id":5},{"id":8,"name":"vel perspiciatis quo","description":"Et qui praesentium consequatur distinctio natus.","url":null,"due_at":20210605,"created_at":"2021-05-30T00:25:43.000000Z","updated_at":"2021-05-30T00:25:43.000000Z","user_id":1},{"id":9,"name":"qui et totam","description":"Veritatis quo dolorum soluta ut.","url":null,"due_at":20270203,"created_at":"2021-05-30T00:25:43.000000Z","updated_at":"2021-05-30T00:25:43.000000Z","user_id":1}]'
content: '[]'
headers:
cache-control: 'no-cache, private'
content-type: application/json
x-ratelimit-limit: '60'
x-ratelimit-remaining: '53'
x-ratelimit-remaining: '45'
access-control-allow-origin: '*'
description: null
custom: []
Expand Down Expand Up @@ -90,33 +90,41 @@ endpoints:
required: true
example: 'The SideProject API'
type: string
enumValues: []
exampleWasSpecified: false
custom: []
description:
name: description
description: 'A longer description of your side project. Must not be greater than 255 characters.'
required: false
example: pidsgyfhasfdpmrgozmxiqtrcoqjruexeugqpersioudgkpsbnkltlaqvmwjyiahevihxmbowbowymkwgcqxiqmrchyclplgrcipefeeopzzxuuljqvytlucrlnslwwcdxrknhwrlmabpwubvoetriefhfwzv
example: 'Suscipit qui cumque magnam tenetur quia nemo.'
type: string
enumValues: []
exampleWasSpecified: false
custom: []
url:
name: url
description: 'A url to your side project. Must be a valid URL.'
required: false
example: 'http://hartmann.com/magnam-tenetur-quia-nemo-sit-est-numquam'
example: 'http://www.reilly.com/'
type: string
enumValues: []
exampleWasSpecified: false
custom: []
due_at:
name: due_at
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>.'
required: false
example: '2084-02-27'
example: '2085-06-01'
type: string
enumValues: []
exampleWasSpecified: false
custom: []
cleanBodyParameters:
name: 'The SideProject API'
description: pidsgyfhasfdpmrgozmxiqtrcoqjruexeugqpersioudgkpsbnkltlaqvmwjyiahevihxmbowbowymkwgcqxiqmrchyclplgrcipefeeopzzxuuljqvytlucrlnslwwcdxrknhwrlmabpwubvoetriefhfwzv
url: 'http://hartmann.com/magnam-tenetur-quia-nemo-sit-est-numquam'
due_at: '2084-02-27'
description: 'Suscipit qui cumque magnam tenetur quia nemo.'
url: 'http://www.reilly.com/'
due_at: '2085-06-01'
fileParameters: []
responses: []
responseFields: []
Expand Down Expand Up @@ -159,11 +167,13 @@ endpoints:
name: id
description: 'The ID of the side project.'
required: true
example: 1
example: 13
type: integer
enumValues: []
exampleWasSpecified: false
custom: []
cleanUrlParameters:
id: 1
id: 13
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
Expand All @@ -172,15 +182,15 @@ endpoints:
responses:
-
status: 203
content: '{"data":{"name":"suscipit qui cumque","description":"Tenetur quia nemo sit est.","due_date":"20241106","owner":{"id":6,"name":"Kurt Kub","email":"[email protected]","email_verified_at":"2022-09-10T02:22:37.000000Z","created_at":"2022-09-10T02:22:37.000000Z","updated_at":"2022-09-10T02:22:37.000000Z"}}}'
content: '{"data":{"name":"suscipit qui cumque","description":"Tenetur quia nemo sit est.","due_date":20260208,"owner":{"id":1,"name":"Kurt Kub","email":"[email protected]","email_verified_at":"2023-12-13T23:29:24.000000Z","created_at":"2023-12-13T23:29:24.000000Z","updated_at":"2023-12-13T23:29:24.000000Z"}}}'
headers: []
description: ''
custom: []
-
status: 404
content: '{"message":"Not found","resource":"Side project"}'
headers: []
description: '404, Side project not found'
description: 'Side project not found'
custom: []
responseFields: []
auth: []
Expand Down Expand Up @@ -214,11 +224,13 @@ endpoints:
name: id
description: 'The ID of the side project.'
required: true
example: 1
example: 13
type: integer
enumValues: []
exampleWasSpecified: false
custom: []
cleanUrlParameters:
id: 1
id: 13
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
Expand Down Expand Up @@ -256,18 +268,22 @@ endpoints:
name: id
description: 'The ID of the side project.'
required: true
example: 1
example: 13
type: integer
enumValues: []
exampleWasSpecified: false
custom: []
cleanUrlParameters:
id: 1
id: 13
queryParameters:
queryThing:
name: queryThing
description: null
required: false
example: null
type: string
enumValues: []
exampleWasSpecified: false
custom: []
cleanQueryParameters: []
bodyParameters: []
Expand Down
Loading

0 comments on commit 52771ed

Please sign in to comment.