Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-06-03 04:24:36 -04:00
Code Issues Packages Projects Releases Wiki Activity

OPENApi documentation

Browse Source
This commit is contained in:
David Bomba 2020-07-30 12:50:45 +10:00
parent a6967892ea
commit 1db8b53128
1 changed files with 40 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
app/Http/Controllers/PingController.php
View File

@ -19,9 +19,26 @@ class PingController extends BaseController
{ {
/** /**
* Display a listing of the resource. * Get a ping response from the system.
* *
* @return \Illuminate\Http\Response * @return \Illuminate\Http\Response
*
* @OA\Get(
* path="/api/v1/ping",
* operationId="getPing",
* tags={"ping"},
* summary="Attempts to ping the API",
* description="Attempts to ping the API",
* @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\Response(
* response=200,
* description="The company and user name",
* @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
* @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
* @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
* )
* )
*/ */
public function index() public function index()
{ {
@ -31,6 +48,28 @@ class PingController extends BaseController
], 200); ], 200);
} }
/**
* Get a health check of the system
*
* @return \Illuminate\Http\Response
*
* @OA\Get(
* path="/api/v1/health_check",
* operationId="getHealthCheck",
* tags={"health_check"},
* summary="Attempts to get a health check from the API",
* description="Attempts to get a health check from the API",
* @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\Response(
* response=200,
* description="A key/value map of the system health",
* @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
* @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
* @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
* )
* )
*/
public function health() public function health()
{ {
if(Ninja::isNinja()) if(Ninja::isNinja())