Improve incident API

cachethq · Dec 2, 2024 · 33102cd · 33102cd
1 parent 10e916f
commit 33102cd
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/src/Http/Controllers/Api/IncidentController.php b/src/Http/Controllers/Api/IncidentController.php
@@ -19,6 +19,15 @@
  */
 class IncidentController extends Controller
 {
+    /**
+     * The list of allowed includes.
+     */
+    public const ALLOWED_INCLUDES = [
+        'components',
+        'incidentUpdates',
+        'user',
+    ];
+
     /**
      * List Incidents
      *
@@ -29,15 +38,15 @@ class IncidentController extends Controller
      * @queryParam per_page int How many items to show per page. Example: 20
      * @queryParam page int Which page to show. Example: 2
      * @queryParam sort string Field to sort by. Enum: name, id, status Example: status
-     * @queryParam include string Include related resources. Enum: updates Example: updates
+     * @queryParam include string Include related resources. Enum: components, incidentUpdates, user Example: incidentUpdates
      */
     public function index()
     {
         $incidents = QueryBuilder::for(Incident::class)
             ->when(! request('sort'), function (Builder $builder) {
                 $builder->orderByDesc('created_at');
             })
-            ->allowedIncludes(['updates'])
+            ->allowedIncludes(self::ALLOWED_INCLUDES)
             ->allowedFilters(['name', 'status', 'occurred_at'])
             ->allowedSorts(['name', 'status', 'id'])
             ->simplePaginate(request('per_page', 15));
@@ -67,10 +76,16 @@ public function store(CreateIncidentRequest $request, CreateIncident $createInci
      * @apiResource \Cachet\Http\Resources\Incident
      *
      * @apiResourceModel \Cachet\Models\Incident
+     *
+     * @queryParam include string Include related resources. Enum: components, incidentUpdates, user Example: incidentUpdates
      */
     public function show(Incident $incident)
     {
-        return IncidentResource::make($incident)
+        $incidentQuery = QueryBuilder::for($incident)
+            ->allowedIncludes(self::ALLOWED_INCLUDES)
+            ->first();
+
+        return IncidentResource::make($incidentQuery)
             ->response()
             ->setStatusCode(Response::HTTP_OK);
     }

diff --git a/tests/Feature/Api/IncidentTest.php b/tests/Feature/Api/IncidentTest.php
@@ -174,7 +174,7 @@
 it('can get an incident with updates', function () {
     $incident = Incident::factory()->hasIncidentUpdates(2)->create();
 
-    $response = getJson('/status/api/incidents/'.$incident->id.'?include=inidcent_updates');
+    $response = getJson('/status/api/incidents/'.$incident->id.'?include=incidentUpdates');
 
     $response->assertOk();
     $response->assertJsonFragment([