1	<?php
2
3	/**
4	* @apiDefine SuccessGet Response-Content
5	*
6	* @apiParam (GET) {String} page Page number of result.
7	*
8	* @apiSuccess (Response-Content)   {String}     current_page    page called.
9	* @apiSuccess (Response-Content)   {Array}      data            Array of asked data.
10	* @apiSuccess (Response-Content)   {String}     first_page_url  first page url.
11	* @apiSuccess (Response-Content)   {String}     next_page_url   next page url.
12	* @apiSuccess (Response-Content)   {String}     path            Base url.
13	* @apiSuccess (Response-Content)   {String}     prev_page_url   previous page url.
14	* @apiSuccess (Response-Content)   {Integer}    from            first entry index.
15	* @apiSuccess (Response-Content)   {Integer}    per_page        nb of entries by page.
16	* @apiSuccess (Response-Content)   {Integer}    to              last entry index.
17	*
18	*
19	*
20	* @apiSuccessExample Response-Content (example):
21	*     HTTP/1.1 200 OK
22	*     {
23	*
24	* @apiSuccessExample Response-Content (example):
25	*     HTTP/1.1 200 OK
26	*     {
27	*      "first_page_url": "http://xxxx/xxx?page=2",
28	*      "from": 16,
29	*      "last_page": 4,
30	*      "last_page_url": "http://xxxx/xxx?page=4",
31	*      "next_page_url": http://xxxx/xxx?page=3,
32	*      "path": "http://david-api-digital.advertise-me.net/api/latest/user/users",
33	*      "per_page": 15,
34	*      "prev_page_url": http://xxxx/xxx?page=1,
35	*      "to": 30,
36	*      "total": 60
37	*     }
38	*/
39
40	/**
41	* @apiDefine EntityError Error 422
42	*
43	* @apiError (Error 422) {json} Unprocessable Entity Something wrong with parameters.
44	*
45	* @apiErrorExample {json} 422:
46	*     HTTP/1.1 422 Unprocessable Entity
47	*     {
48	*       "error": "error description"
49	*     }
50	*/
51
52	/**
53	* @apiDefine UserId Request-Header
54	*
55	* @apiHeader (UserId) {Integer} X-Qwamplify-user-id User-id.
56	*
57	* @apiHeaderExample {json} Header (Example) :
58	*     {
59	*           "X-Qwamplify-user-id" : 1
60	*     }
61	*/
62
63	/**
64	* @api {get} http://service_file_generator/api/file-generator xxx
65	* @apiVersion 1.0.0
66	* @apiName xxx
67	* @apiGroup xxx
68	* @apiDescription xxx
69	* @apiPermission xxx
70	*
71	* @apiUse UserId
72	* @apiUse SuccessGet
73	*
74	*/
75
76	/**
77	* @api {get} http://service_file_generator/api/file-generator/{id} xxx
78	* @apiVersion 1.0.0
79	* @apiName xxx
80	* @apiGroup xxx
81	* @apiDescription xxx
82	* @apiPermission xxx
83	*
84	* @apiUse UserId
85	*
86	* @apiSuccessExample Response-Data (example):
87	*     HTTP/1.1 200 Ok
88	*     {
89	*
90	*     }
91	*
92	*/
93
94	/**
95	* @api {post} http://service_file_generator/api/file-generator xxx
96	* @apiVersion 1.0.0
97	* @apiName xxx
98	* @apiGroup xxx
99	* @apiDescription xxx
100	* @apiPermission xxx
101	*
102	* @apiUse UserId
103	*
104	*
105	*
106	* @apiSuccessExample Response-Data (example):
107	*     HTTP/1.1 201 Created
108	*     {
109	*         status: ok,
110	*         permission: 123
111	*     }
112	*
113	* @apiUse EntityError
114	*/
115
116	/**
117	* @api {put} http://service_file_generator/api/file-generator/{id} xxx
118	* @apiVersion 1.0.0
119	* @apiName xxx
120	* @apiGroup xxx
121	* @apiDescription xxx
122	* @apiPermission xxx
123	*
124	* @apiUse UserId
125	*
126	*
127	*
128	* @apiSuccessExample Response-Data (example):
129	*     HTTP/1.1 200 Ok
130	*     {
131	*         status: ok
132	*     }
133	*
134	* @apiUse EntityError
135	*/
136
137	/**
138	* @api {delete} http://service_file_generator/api/file-generator/{id} xxx
139	* @apiVersion 1.0.0
140	* @apiName xxx
141	* @apiGroup xxx
142	* @apiDescription xxx
143	* @apiPermission xxx
144	*
145	* @apiUse UserId
146	*
147	* @apiSuccessExample Response-Data (example):
148	*     HTTP/1.1 200 Ok
149	*     {
150	*         status: ok
151	*     }
152	*
153	* @apiUse EntityError
154	*/