This repository has been archived by the owner on Jun 13, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
/
config.php
205 lines (177 loc) · 5.62 KB
/
config.php
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<?php
return [
/**
* Dev Mode
*
* While in dev mode, the stack trace of errors are printed in the
* json response body. By default, this `devMode` observes the default
* setting of the `devMode` in Craft's general configuration.
*/
'devMode' => \Craft\craft()->config->get('devMode'),
/**
* Api Route Prefix
*
* The Api Route Prefix acts as a namespace and is prepended to all
* routes that the API plugin defines.
*/
'apiRoutePrefix' => 'api',
/**
* Default Headers
*
* These headers will be sent with every Response.
*/
'defaultHeaders' => [
'Pragma' => [
'no-cache',
],
'Cache-Control' => [
'no-store',
'no-cache',
'must-revalidate',
'post-check=0',
'pre-check=0',
],
'Content-Type' => [
'application/json; charset=utf-8',
],
],
/**
* Page Trigger
*
* The query string parametere for pagination. If the value is the same as
* Craft's `pageTrigger`, an exception will be thrown.
*/
'paginationParameter' => 'page',
/**
* Pagination Base Url
*
* The url that is prepended to all pagination links.
*/
'paginationBaseUrl' => \Craft\craft()->request->getPath(),
/**
* Content Model Fields Location
*
* This is the key, in the body of $_POST or php://input, in which
* content that will need to be added to the element's content
* model.
*/
'contentModelFieldsLocation' => 'fields',
/**
* Content Recursion Limit
*
* This is the number of times content fields can be populated recursively.
* With complex data models that have multiple relationships, populating content
* automatically can pull in a lot of extra data.
*/
'contentRecursionLimit' => 2,
/**
* Default Auth
*
* The authentication method that should be applied to all requests. `null` will disable
* authentication altogether.
*/
'defaultAuth' => null,
/**
* Auth
*
* Settings authentication methods
*/
'auth' => [
'basicAuth' => [
'username' => '',
'password' => '',
],
'craft' => [
'permissions' => [],
'users' => [],
'groups' => [],
],
],
/**
* Autoload
*
* Determine which directories should have thier files autoloaded.
*
* `true` loads the files in that directory across ALL plugins.
* `false` loads the files in that directory only in the RestfulApi plugin.
*/
'autoload' => [
'transformers' => true,
'validators' => true,
],
/**
* Default Serializers
*
* A Serializer structures your Transformed data in certain ways.
* For more info, see http://fractal.thephpleague.com/serializers/.
*/
'defaultSerializer' => 'ArraySerializer',
/**
* Serializers
*
* Available serializers that can be specified as default serializer.
*/
'serializers' => [
'ArraySerializer' => 'League\\Fractal\\Serializer\\ArraySerializer',
'DataArraySerializer' => 'League\\Fractal\\Serializer\\DataArraySerializer',
'JsonApiSerializer' => 'League\\Fractal\\Serializer\\JsonApiSerializer',
],
/**
* Exception Transformer
*
* This transformer will be applied to all thrown exceptions.
*/
'exceptionTransformer' => 'RestfulApi\\Transformers\\ArrayTransformer',
/**
* Element Types
*
* Define settings for each element type. If no setting is defined for an element type,
* the default settings defined in the `*` wildcard will be inherited.
*/
'elementTypes' => [
'*' => [
'enabled' => true,
'transformer' => 'RestfulApi\\Transformers\\ArrayTransformer',
'validator' => null,
'permissions' => [
'public' => ['GET'],
'authenticated' => ['POST', 'PUT', 'PATCH'],
],
],
'Asset' => [
'enabled' => true,
'transformer' => 'RestfulApi\\Transformers\\AssetFileTransformer',
'validator' => 'RestfulApi\\Validators\AssetFileValidator',
],
'Category' => [
'enabled' => true,
'transformer' => 'RestfulApi\\Transformers\\CategoryTransformer',
'validator' => 'RestfulApi\\Validators\\CategoryValidator',
],
'Entry' => [
'enabled' => true,
'transformer' => 'RestfulApi\\Transformers\\EntryTransformer',
'validator' => 'RestfulApi\\Validators\\EntryValidator',
],
'GlobalSet' => [
'enabled' => true,
'transformer' => 'RestfulApi\\Transformers\\GlobalSetTransformer',
'validator' => 'RestfulApi\\Validators\\GlobalSetValidator',
],
'MatrixBlock' => [
'enabled' => true,
'transformer' => 'RestfulApi\\Transformers\\MatrixBlockTransformer',
'validator' => 'RestfulApi\\Validators\\MatrixBlockValidator',
],
'Tag' => [
'enabled' => true,
'transformer' => 'RestfulApi\\Transformers\\TagTransformer',
'validator' => 'RestfulApi\\Validators\\TagValidator',
],
'User' => [
'enabled' => true,
'transformer' => 'RestfulApi\\Transformers\\UserTransformer',
'validator' => 'RestfulApi\\Validators\\UserValidator',
],
],
];