[DEV-17093] Add API health point

matomo-org · Aug 24, 2023 · 550d489 · 550d489
1 parent 5c2a47d
commit 550d489
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/plugins/API/API.php b/plugins/API/API.php
@@ -87,6 +87,13 @@ public function getMatomoVersion()
         return Version::VERSION;
     }
 
+    public function getHealthCheck(): array
+    {
+        return [
+            'status' => 'ok'
+        ];
+    }
+
     /**
      * Get PHP version
      * @return array

diff --git a/plugins/API/tests/Integration/APITest.php b/plugins/API/tests/Integration/APITest.php
@@ -71,6 +71,18 @@ public function test_getBulkRequest_IsAbleToHandleManyDifferentRequests()
         $this->assertResponseIsSuccess($response[4]);
     }
 
+    public function test_getHealthCheck_ReturnsStatusOk(): void
+    {
+        $response = $this->api->getHealthCheck();
+
+        $this->assertSame(
+            [
+                'status' => 'ok'
+            ],
+            $response
+        );
+    }
+
     private function assertResponseIsPermissionError($response)
     {
         $this->assertSame('error', $response['result']);