-
Notifications
You must be signed in to change notification settings - Fork 10.3k
/
plugin-schemas.json
238 lines (238 loc) · 9.84 KB
/
plugin-schemas.json
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
{
"gatsby-source-wordpress": "TODO: no schema in https://github.com/gatsbyjs/gatsby-source-wordpress-experimental/blob/master/plugin/gatsby-node.js",
"gatsby-source-contentful": {
"type": "object",
"externals": [{}],
"keys": {
"accessToken": {
"type": "string",
"flags": {
"description": "Contentful delivery api key, when using the Preview API use your Preview API key",
"presence": "required"
}
},
"spaceId": {
"type": "string",
"flags": { "description": "Contentful spaceId", "presence": "required" }
},
"host": {
"type": "string",
"flags": {
"description": "The base host for all the API requests, by default it's 'cdn.contentful.com', if you want to use the Preview API set it to 'preview.contentful.com'. You can use your own host for debugging/testing purposes as long as you respect the same Contentful JSON structure.",
"default": "cdn.contentful.com"
}
},
"environment": {
"type": "string",
"flags": {
"description": "The environment to pull the content from, for more info on environments check out this [Guide](https://www.contentful.com/developers/docs/concepts/multiple-environments/).",
"default": "master"
}
},
"downloadLocal": {
"type": "boolean",
"flags": {
"description": "Downloads and caches ContentfulAsset's to the local filesystem. Allows you to query a ContentfulAsset's localFile field, which is not linked to Contentful's CDN. Useful for reducing data usage.\nYou can pass in any other options available in the [contentful.js SDK](https://github.com/contentful/contentful.js#configuration).",
"default": false
}
},
"localeFilter": {
"type": "function",
"flags": {
"description": "Possibility to limit how many locales/nodes are created in GraphQL. This can limit the memory usage by reducing the amount of nodes created. Useful if you have a large space in contentful and only want to get the data from one selected locale.\nFor example, to filter locales on only germany `localeFilter: locale => locale.code === 'de-DE'`\n\nList of locales and their codes can be found in Contentful app -> Settings -> Locales"
}
},
"forceFullSync": {
"type": "boolean",
"flags": {
"description": "Prevents the use of sync tokens when accessing the Contentful API.",
"default": false
}
},
"pageLimit": {
"type": "number",
"flags": {
"description": "Number of entries to retrieve from Contentful at a time. Due to some technical limitations, the response payload should not be greater than 7MB when pulling content from Contentful. If you encounter this issue you can set this param to a lower number than 100, e.g 50.",
"default": 100
},
"rules": [{ "name": "integer" }]
},
"assetDownloadWorkers": {
"type": "number",
"flags": {
"description": "Number of workers to use when downloading contentful assets. Due to technical limitations, opening too many concurrent requests can cause stalled downloads. If you encounter this issue you can set this param to a lower number than 50, e.g 25.",
"default": 50
},
"rules": [{ "name": "integer" }]
},
"proxy": {
"type": "object",
"flags": {
"description": "Axios proxy configuration. See the [axios request config documentation](https://github.com/mzabriskie/axios#request-config) for further information about the supported values."
},
"keys": {
"host": { "type": "string", "flags": { "presence": "required" } },
"port": { "type": "number", "flags": { "presence": "required" } },
"auth": {
"type": "object",
"keys": {
"username": { "type": "string" },
"password": { "type": "string" }
}
}
}
},
"useNameForId": {
"type": "boolean",
"flags": {
"description": "Use the content's `name` when generating the GraphQL schema e.g. a Content Type called `[Component] Navigation bar` will be named `contentfulComponentNavigationBar`.\n When set to `false`, the content's internal ID will be used instead e.g. a Content Type with the ID `navigationBar` will be called `contentfulNavigationBar`.\n\n Using the ID is a much more stable property to work with as it will change less often. However, in some scenarios, Content Types' IDs will be auto-generated (e.g. when creating a new Content Type without specifying an ID) which means the name in the GraphQL schema will be something like `contentfulC6XwpTaSiiI2Ak2Ww0oi6qa`. This won't change and will still function perfectly as a valid field name but it is obviously pretty ugly to work with.\n\n If you are confident your Content Types will have natural-language IDs (e.g. `blogPost`), then you should set this option to `false`. If you are unable to ensure this, then you should leave this option set to `true` (the default).",
"default": true
}
},
"plugins": { "type": "array" },
"richText": {
"type": "object",
"flags": { "default": {} },
"keys": {
"resolveFieldLocales": {
"type": "boolean",
"flags": {
"description": "If you want to resolve the locales in fields of assets and entries that are referenced by rich text (e.g., via embedded entries or entry hyperlinks), set this to `true`. Otherwise, fields of referenced assets or entries will be objects keyed by locale.",
"default": false
}
}
}
}
}
},
"gatsby-source-datocms": "TODO: no schema in https://github.com/datocms/gatsby-source-datocms/blob/master/src/gatsby-node.js",
"gatsby-source-sanity": "TODO: no schema in https://github.com/sanity-io/gatsby-source-sanity/blob/main/src/gatsby-node.ts",
"gatsby-source-agility": "TODO: no schema in https://github.com/agility/gatsby-source-agilitycms/blob/master/gatsby-node.js",
"gatsby-plugin-postcss": {},
"gatsby-plugin-styled-components": {},
"gatsby-plugin-emotion": {},
"gatsby-plugin-sass": {},
"gatsby-plugin-themeui": {},
"gatsby-plugin-google-analytics": {
"type": "object",
"keys": {
"trackingId": {
"type": "string",
"flags": {
"description": "The property ID; the tracking code won't be generated without it",
"presence": "required"
}
},
"head": {
"type": "boolean",
"flags": {
"default": false,
"description": "Defines where to place the tracking script - `true` in the head and `false` in the body"
}
},
"anonymize": { "type": "boolean", "flags": { "default": false } },
"respectDNT": { "type": "boolean", "flags": { "default": false } },
"exclude": {
"type": "array",
"flags": {
"default": [],
"description": "Avoids sending pageview hits from custom paths"
},
"items": [{ "type": "string" }]
},
"pageTransitionDelay": {
"type": "number",
"flags": {
"default": 0,
"description": "Delays sending pageview hits on route update (in milliseconds)"
}
},
"optimizeId": {
"type": "string",
"flags": {
"description": "Enables Google Optimize using your container Id"
}
},
"experimentId": {
"type": "string",
"flags": { "description": "Enables Google Optimize Experiment ID" }
},
"variationId": {
"type": "string",
"flags": { "description": "Set Variation ID. 0 for original 1,2,3...." }
},
"defer": {
"type": "boolean",
"flags": {
"description": "Defers execution of google analytics script after page load"
}
},
"sampleRate": { "type": "number" },
"siteSpeedSampleRate": { "type": "number" },
"cookieDomain": { "type": "string" }
}
},
"gatsby-plugin-sitemap": {},
"gatsby-plugin-mdx": {},
"gatsby-plugin-offline": {},
"gatsby-plugin-manifest": {
"type": "object",
"keys": {
"name": { "type": "string" },
"short_name": { "type": "string" },
"description": { "type": "string" },
"lang": { "type": "string" },
"localize": {
"type": "array",
"items": [
{
"type": "object",
"keys": {
"start_url": { "type": "string" },
"name": { "type": "string" },
"short_name": { "type": "string" },
"description": { "type": "string" },
"lang": { "type": "string" }
}
}
]
},
"start_url": { "type": "string" },
"background_color": { "type": "string" },
"theme_color": { "type": "string" },
"display": { "type": "string" },
"legacy": { "type": "boolean" },
"include_favicon": { "type": "boolean" },
"icon": { "type": "string" },
"theme_color_in_head": { "type": "boolean" },
"crossOrigin": {
"type": "string",
"flags": { "only": true },
"allow": ["use-credentials", "anonymous"]
},
"cache_busting_mode": {
"type": "string",
"flags": { "only": true },
"allow": ["query", "name", "none"]
},
"icons": {
"type": "array",
"items": [
{
"type": "object",
"keys": {
"src": { "type": "string" },
"sizes": { "type": "string" },
"type": { "type": "string" },
"purpose": { "type": "string" }
}
}
]
},
"icon_options": {
"type": "object",
"keys": { "purpose": { "type": "string" } }
}
}
}
}