redirection / api / api.php

api.php in Redirection 5.6.0, at api/api.php

64 lines 1.7 KB

Raw Download Zip

1	<?php
2
3	require_once __DIR__ . '/api-route.php';
4	require_once __DIR__ . '/api-filter-route.php';
5	require_once __DIR__ . '/api-group.php';
6	require_once __DIR__ . '/api-redirect.php';
7	require_once __DIR__ . '/api-log.php';
8	require_once __DIR__ . '/api-404.php';
9	require_once __DIR__ . '/api-settings.php';
10	require_once __DIR__ . '/api-plugin.php';
11	require_once __DIR__ . '/api-import.php';
12	require_once __DIR__ . '/api-export.php';
13	require_once __DIR__ . '/api-core.php';
14
15	define( 'REDIRECTION_API_NAMESPACE', 'redirection/v1' );
16
17	/**
18	* @apiDefine 401Error
19	*
20	* @apiError (Error 401) rest_forbidden You are not authorized to access this API endpoint
21	* @apiErrorExample {json} 401 Error Response:
22	* HTTP/1.1 401 Bad Request
23	* {
24	* "code": "rest_forbidden",
25	* "message": "Sorry, you are not allowed to do that."
26	* }
27	*/
28
29	/**
30	* @apiDefine 404Error
31	*
32	* @apiError (Error 404) rest_no_route Endpoint not found
33	* @apiErrorExample {json} 404 Error Response:
34	* HTTP/1.1 404 Not Found
35	* {
36	* "code": "rest_no_route",
37	* "message": "No route was found matching the URL and request method"
38	* }
39	*/
40
41	/**
42	* @apiDefine 400Error
43	*
44	* @apiError rest_forbidden You are not authorized to access this API endpoint
45	* @apiErrorExample {json} 400 Error Response:
46	* HTTP/1.1 400 Bad Request
47	* {
48	* "error": "invalid",
49	* "message": "Invalid request"
50	* }
51	*/
52
53	/**
54	* @apiDefine 400MissingError
55	*
56	* @apiError (Error 400) rest_missing_callback_param Some required parameters are not present or not in the correct format
57	* @apiErrorExample {json} 400 Error Response:
58	* HTTP/1.1 400 Bad Request
59	* {
60	* "code": "rest_missing_callback_param",
61	* "message": "Missing parameter(s): PARAM"
62	* }
63	*/
64