Skip to content

[PMM-631]: Update tSOA guide #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
philsturgeon wants to merge 11 commits into
base: main
Choose a base branch
from
Open

[PMM-631]: Update tSOA guide #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f0021f7
laravel: track the generated openapi
philsturgeon Dec 12, 2025
21dd251
laravel: at least give all good titles
philsturgeon Dec 12, 2025
1a1814c
framework tsoa import
philsturgeon Dec 12, 2025
270cc38
switch to yarn not npm
philsturgeon Dec 12, 2025
f8133c9
tsoa on express v5 skipping hapi
philsturgeon Dec 12, 2025
3851ea4
tsoa: use yarn not npm
philsturgeon Dec 12, 2025
f696316
tsoa: simplify and modernize tsconfig
philsturgeon Dec 12, 2025
7c0a234
updated sdk to use new train example
philsturgeon Dec 28, 2025
77a3dd3
new train travel tsoa app in oas3.1
philsturgeon Dec 28, 2025
1085118
swapped swagger for scalar docs
philsturgeon Dec 28, 2025
6f8add2
Add payments concept to show off enums and unions
philsturgeon Dec 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion frameworks-laravel/app/Http/Controllers/Api/CircuitController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
class CircuitController extends Controller
{
/**
* Display a listing of the resource.
* Get circuits
*
* Returns a collection of all race circuits.
*/
public function index(): CircuitCollection
{
Expand Down
4 changes: 3 additions & 1 deletion frameworks-laravel/app/Http/Controllers/Api/DriverController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
class DriverController extends Controller
{
/**
* Display a listing of the resource.
* Get drivers
*
* Returns a collection of driver resources, optionally filtered by race.
*/
public function index(Request $request): DriverCollection
{
Expand Down
51 changes: 32 additions & 19 deletions frameworks-laravel/resources/views/scribe/index.blade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,25 +75,32 @@
<a href="#endpoints-GETapi-health">Healthcheck</a>
</li>
<li class="tocify-item level-2" data-unique="endpoints-GETapi-drivers">
<a href="#endpoints-GETapi-drivers">Display a listing of the resource.</a>
<a href="#endpoints-GETapi-drivers">Get drivers</a>
</li>
<li class="tocify-item level-2" data-unique="endpoints-GETapi-drivers--id-">
<a href="#endpoints-GETapi-drivers--id-">Display the specified resource.</a>
</li>
<li class="tocify-item level-2" data-unique="endpoints-GETapi-circuits">
<a href="#endpoints-GETapi-circuits">Display a listing of the resource.</a>
<a href="#endpoints-GETapi-circuits">Get circuits</a>
</li>
<li class="tocify-item level-2" data-unique="endpoints-GETapi-circuits--id-">
<a href="#endpoints-GETapi-circuits--id-">Display the specified resource.</a>
</li>
<li class="tocify-item level-2" data-unique="endpoints-GETapi-races">
<a href="#endpoints-GETapi-races">Get races</a>
</ul>
</ul>
<ul id="tocify-header-races" class="tocify-header">
<li class="tocify-item level-1" data-unique="races">
<a href="#races">Races</a>
</li>
<ul id="tocify-subheader-races" class="tocify-subheader">
<li class="tocify-item level-2" data-unique="races-GETapi-races">
<a href="#races-GETapi-races">Get races</a>
</li>
<li class="tocify-item level-2" data-unique="endpoints-GETapi-races--id-">
<a href="#endpoints-GETapi-races--id-">Display the specified resource.</a>
<li class="tocify-item level-2" data-unique="races-GETapi-races--id-">
<a href="#races-GETapi-races--id-">Display the specified resource.</a>
</li>
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-races">
<a href="#endpoints-POSTapi-races">Create a race</a>
<li class="tocify-item level-2" data-unique="races-POSTapi-races">
<a href="#races-POSTapi-races">Create a race</a>
</li>
</ul>
</ul>
Expand All @@ -106,7 +113,7 @@
</ul>

<ul class="toc-footer" id="last-updated">
<li>Last updated: November 16, 2025</li>
<li>Last updated: December 12, 2025</li>
</ul>
</div>

Expand Down Expand Up @@ -180,7 +187,7 @@
<code class="language-json" style="max-height: 300px;">{
&quot;status&quot;: &quot;healthy&quot;,
&quot;version&quot;: &quot;unversioned&quot;,
&quot;timestamp&quot;: &quot;2025-11-16T15:08:22+00:00&quot;
&quot;timestamp&quot;: &quot;2025-12-12T12:43:23+00:00&quot;
}</code>
</pre>
</span>
Expand Down Expand Up @@ -257,12 +264,12 @@
</div>
</form>

<h2 id="endpoints-GETapi-drivers">Display a listing of the resource.</h2>
<h2 id="endpoints-GETapi-drivers">Get drivers</h2>

<p>
</p>


<p>Returns a collection of driver resources, optionally filtered by race.</p>

<span id="example-requests-GETapi-drivers">
<blockquote>Example request:</blockquote>
Expand Down Expand Up @@ -602,12 +609,12 @@
</div>
</form>

<h2 id="endpoints-GETapi-circuits">Display a listing of the resource.</h2>
<h2 id="endpoints-GETapi-circuits">Get circuits</h2>

<p>
</p>


<p>Returns a collection of all race circuits.</p>

<span id="example-requests-GETapi-circuits">
<blockquote>Example request:</blockquote>
Expand Down Expand Up @@ -947,7 +954,11 @@
</div>
</form>

<h2 id="endpoints-GETapi-races">Get races</h2>
<h1 id="races">Races</h1>

<p>A series of endpoints that allow programmatic access to managing F1 races.</p>

<h2 id="races-GETapi-races">Get races</h2>

<p>
<small class="badge badge-darkred">requires authentication</small>
Expand Down Expand Up @@ -1109,9 +1120,10 @@
</div>
</form>

<h2 id="endpoints-GETapi-races--id-">Display the specified resource.</h2>
<h2 id="races-GETapi-races--id-">Display the specified resource.</h2>

<p>
<small class="badge badge-darkred">requires authentication</small>
</p>


Expand Down Expand Up @@ -1191,7 +1203,7 @@
</span>
<form id="form-GETapi-races--id-" data-method="GET"
data-path="api/races/{id}"
data-authed="0"
data-authed="1"
data-hasfiles="0"
data-isarraybody="0"
autocomplete="off"
Expand Down Expand Up @@ -1260,9 +1272,10 @@
</div>
</form>

<h2 id="endpoints-POSTapi-races">Create a race</h2>
<h2 id="races-POSTapi-races">Create a race</h2>

<p>
<small class="badge badge-darkred">requires authentication</small>
</p>

<p>Allows authenticated users to submit a new Race resource to the system.</p>
Expand Down Expand Up @@ -1337,7 +1350,7 @@
</span>
<form id="form-POSTapi-races" data-method="POST"
data-path="api/races"
data-authed="0"
data-authed="1"
data-hasfiles="0"
data-isarraybody="0"
autocomplete="off"
Expand Down
Loading