-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathClient.php
More file actions
25 lines (23 loc) · 939 Bytes
/
Client.php
File metadata and controls
25 lines (23 loc) · 939 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<?php
namespace Zckrs\GenDocApi\Test;
class Client
{
/**
* @ApiDescription(section="Client", description="Get one client by ID")
* @ApiMethod(type="GET")
* @ApiRoute(name="/api/clients/{id}")
* @ApiParams(name="id", type="integer", nullable=false, description="The client ID")
* @ApiReturnRootSample(sample="{ 'meta': metaObject, 'response': array[responseObject] }")
*
* @ApiReturnObject(section="metaObject", name="status", type="string", desc="Status code returned")
* @ApiReturnObject(section="metaObject", name="msg", type="string", desc="Message to describe status code")
*
* @ApiReturnObject(section="responseObject", name="msg", type="array", desc="A array of responseObject (cf section Content)")
*
* @throws \Exception
*/
public function getClient()
{
throw new \Exception('Oh, this class is just here to perform functional tests!');
}
}