forked from Regaez/grav-plugin-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
blueprints.yaml
481 lines (461 loc) · 14.5 KB
/
blueprints.yaml
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
name: Api
version: 0.1.0
description: A Rest API for GravCMS
icon: plug
author:
name: Thomas Threadgold
email: [email protected]
homepage: https://github.com/regaez/grav-plugin-api
demo: http://demo.yoursite.com
keywords: grav, plugin, rest, api, json
bugs: https://github.com/regaez/grav-plugin-api/issues
docs: https://github.com/regaez/grav-plugin-api/tree/master/docs
license: MIT
dependencies:
- { name: grav, version: '>=1.6.15' }
form:
validation: strict
fields:
general:
type: section
title: General
text: Hover over the field labels to discover more information about the plugin's configuration setting.
underline: true
enabled:
type: toggle
label: Plugin Status
help: Enable, or disable, the API plugin.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
route:
type: text
label: Base Route
help: The base route for the API. All API endpoints will be prefixed with this route.
validate:
required: true
message: You must provide a valid base route for the API. It can be alphanumeric, must start with slash, and cannot contain two consecutive slashes.
pattern: '^(?!.*\/\/)\/[a-zA-Z0-9_\-\/]+$'
endpoints:
type: section
title: Endpoints
underline: true
endpoints./pages:
type: fieldset
title: /pages
text: Configure whether clients can read, create, edit, or delete pages by enabling or disabling the following HTTP methods.
collapsed: true
collapsible: true
icon: copy
fields:
Get:
type: section
title: GET
text: This method allows clients to read page data.
underline: true
endpoints./pages.get.enabled:
type: toggle
label: Enable
help: Enable, or disable, the GET method for the `/pages` endpoint.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./pages.get.auth:
type: toggle
label: Authentication
help: Enabling this endpoint will require a client to have valid user credentials and the `api.super` or `api.pages_read` roles.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./pages.get.fields:
type: selectize
selectize:
options:
- text: Title
value: title
- text: Frontmatter
value: frontmatter
- text: Header
value: header
- text: Raw Markdown
value: rawMarkdown
- text: Content
value: content
- text: Route
value: route
- text: Page Order
value: order
- text: Slug
value: slug
- text: Permalink
value: permalink
- text: Template
value: template
- text: Published
value: published
- text: Date
value: date
- text: Modified
value: modified
- text: Media
value: media
size: large
label: Page Attributes
classes: fancy
help: Choose which page attributes will be returned when requesting a PageResource.
validate:
type: commalist
Post:
type: section
title: POST
text: This method allows clients to create new pages.
underline: true
endpoints./pages.post.enabled:
type: toggle
label: Enable
help: Enable, or disable, the POST method for the `/pages` endpoint.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./pages.post.auth:
type: toggle
label: Authentication
help: Enabling this endpoint will require a client to have valid user credentials and the `api.super` or `api.pages_create` roles.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
Patch:
type: section
title: PATCH
text: This method allows clients to update existing pages.
underline: true
endpoints./pages.patch.enabled:
type: toggle
label: Enable
help: Enable, or disable, the PATCH method for the `/pages` endpoint.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./pages.patch.auth:
type: toggle
label: Authentication
help: Enabling this endpoint will require a client to have valid user credentials and the `api.super` or `api.pages_edit` roles.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
Delete:
type: section
title: DELETE
text: This method allows clients to delete existing pages.
underline: true
endpoints./pages.delete.enabled:
type: toggle
label: Enable
help: Enable, or disable, the DELETE method for the `/pages` endpoint.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./pages.delete.auth:
type: toggle
label: Authentication
help: Enabling this endpoint will require a client to have valid user credentials and the `api.super` or `api.pages_read` roles.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./users:
type: fieldset
title: /users
text: Configure whether clients can read, create, edit, or delete user accounts by enabling or disabling the following HTTP methods.
collapsed: true
collapsible: true
icon: users
fields:
Get:
type: section
title: GET
text: This method allows clients to read user data.
underline: true
endpoints./users.get.enabled:
type: toggle
label: Enable
help: Enable, or disable, the GET method for the `/users` endpoint.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./users.get.auth:
type: toggle
label: Authentication
help: Enabling this endpoint will require a client to have valid user credentials and the `api.super` or `api.users_read` roles.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./users.get.fields:
type: selectize
selectize:
options:
- text: Username
value: username
- text: Email
value: email
- text: Fullname
value: fullname
- text: Title
value: title
- text: State
value: state
- text: Access
value: access
- text: Groups
value: groups
size: large
label: User Attributes
classes: fancy
help: Choose which user attributes will be returned when requesting a UserResource.
validate:
type: commalist
Post:
type: section
title: POST
text: This method allows clients to create new users.
underline: true
endpoints./users.post.enabled:
type: toggle
label: Enable
help: Enable, or disable, the POST method for the `/users` endpoint.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./users.post.auth:
type: toggle
label: Authentication
help: Enabling this endpoint will require a client to have valid user credentials and the `api.super` or `api.users_create` roles.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
Patch:
type: section
title: PATCH
text: This method allows clients to update existing users.
underline: true
endpoints./users.patch.enabled:
type: toggle
label: Enable
help: Enable, or disable, the PATCH method for the `/users` endpoint.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./users.patch.auth:
type: toggle
label: Authentication
help: Enabling this endpoint will require a client to have valid user credentials and the `api.super` or `api.users_edit` roles.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
Delete:
type: section
title: DELETE
text: This method allows clients to delete existing users.
underline: true
endpoints./users.delete.enabled:
type: toggle
label: Enable
help: Enable, or disable, the DELETE method for the `/users` endpoint.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./users.delete.auth:
type: toggle
label: Authentication
help: Enabling this endpoint will require a client to have valid user credentials and the `api.super` or `api.users_delete` roles.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./plugins:
type: fieldset
title: /plugins
text: Configure whether clients can read, or edit, install, or uninstall plugins by enabling or disabling the following HTTP methods.
collapsed: true
collapsible: true
icon: plug
fields:
Get:
type: section
title: GET
text: This method allows clients to read plugin configurations.
underline: true
endpoints./plugins.get.enabled:
type: toggle
label: Enable
help: Enable, or disable, the GET method for the `/plugins` endpoint.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./plugins.get.auth:
type: toggle
label: Authentication
help: Enabling this endpoint will require a client to have valid user credentials and the `api.super` or `api.plugins_read` roles.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
Patch:
type: section
title: PATCH
text: This method allows clients to update existing plugin configurations.
underline: true
endpoints./plugins.patch.enabled:
type: toggle
label: Enable
help: Enable, or disable, the PATCH method for the `/plugins` endpoint.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./plugins.patch.auth:
type: toggle
label: Authentication
help: Enabling this endpoint will require a client to have valid user credentials and the `api.super` or `api.plugins_edit` roles.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./configs:
type: fieldset
title: /configs
text: Configure whether clients can read, or edit, site configuration files by enabling or disabling the following HTTP methods.
collapsed: true
collapsible: true
icon: gear
fields:
Get:
type: section
title: GET
text: This method allows clients to read config data.
underline: true
endpoints./configs.get.enabled:
type: toggle
label: Enable
help: Enable, or disable, the GET method for the `/configs` endpoint.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./configs.get.auth:
type: toggle
label: Authentication
help: Enabling this endpoint will require a client to have valid user credentials and the `api.super` or `api.configs_read` roles.
highlight: 1
default: 0
options:
1: Enabled
0: Disabled
validate:
type: bool
endpoints./configs.get.ignore_files:
type: selectize
selectize:
options:
- text: Backups
value: backups
- text: Groups
value: groups
- text: Media
value: media
- text: Scheduler
value: scheduler
- text: Site
value: site
- text: Streams
value: streams
- text: System
value: system
size: large
label: Ignore Files
classes: fancy
help: Choose which Config files will be ignored by the API, preventing you from reading them. By default, the security config will never be returned.
validate:
type: commalist