|
Chris@0
|
1 # Schema for the configuration files of the REST module.
|
|
Chris@0
|
2 rest.settings:
|
|
Chris@0
|
3 type: config_object
|
|
Chris@0
|
4 label: 'REST settings'
|
|
Chris@0
|
5 mapping:
|
|
Chris@0
|
6 # @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
|
|
Chris@0
|
7 # @see https://www.drupal.org/node/2830467
|
|
Chris@0
|
8 link_domain:
|
|
Chris@0
|
9 type: string
|
|
Chris@0
|
10 label: 'Domain of the relation'
|
|
Chris@0
|
11 bc_entity_resource_permissions:
|
|
Chris@0
|
12 type: boolean
|
|
Chris@0
|
13 label: 'Whether the pre Drupal 8.2.x behavior of having permissions for EntityResource is enabled or not.'
|
|
Chris@0
|
14
|
|
Chris@0
|
15 # Method-level granularity of REST resource configuration.
|
|
Chris@0
|
16 rest_resource.method:
|
|
Chris@0
|
17 type: mapping
|
|
Chris@0
|
18 mapping:
|
|
Chris@0
|
19 HEAD:
|
|
Chris@0
|
20 type: rest_request
|
|
Chris@0
|
21 label: 'HEAD method settings'
|
|
Chris@0
|
22 GET:
|
|
Chris@0
|
23 type: rest_request
|
|
Chris@0
|
24 label: 'GET method settings'
|
|
Chris@0
|
25 POST:
|
|
Chris@0
|
26 type: rest_request
|
|
Chris@0
|
27 label: 'POST method settings'
|
|
Chris@0
|
28 PUT:
|
|
Chris@0
|
29 type: rest_request
|
|
Chris@0
|
30 label: 'PUT method settings'
|
|
Chris@0
|
31 DELETE:
|
|
Chris@0
|
32 type: rest_request
|
|
Chris@0
|
33 label: 'DELETE method settings'
|
|
Chris@0
|
34 TRACE:
|
|
Chris@0
|
35 type: rest_request
|
|
Chris@0
|
36 label: 'TRACE method settings'
|
|
Chris@0
|
37 OPTIONS:
|
|
Chris@0
|
38 type: rest_request
|
|
Chris@0
|
39 label: 'OPTIONS method settings'
|
|
Chris@0
|
40 CONNECT:
|
|
Chris@0
|
41 type: rest_request
|
|
Chris@0
|
42 label: 'CONNECT method settings'
|
|
Chris@0
|
43 PATCH:
|
|
Chris@0
|
44 type: rest_request
|
|
Chris@0
|
45 label: 'PATCH method settings'
|
|
Chris@0
|
46
|
|
Chris@0
|
47 # Resource-level granularity of REST resource configuration.
|
|
Chris@0
|
48 rest_resource.resource:
|
|
Chris@0
|
49 type: mapping
|
|
Chris@0
|
50 mapping:
|
|
Chris@0
|
51 methods:
|
|
Chris@0
|
52 type: sequence
|
|
Chris@0
|
53 label: 'Supported methods'
|
|
Chris@0
|
54 sequence:
|
|
Chris@0
|
55 type: string
|
|
Chris@0
|
56 label: 'HTTP method'
|
|
Chris@0
|
57 formats:
|
|
Chris@0
|
58 type: sequence
|
|
Chris@0
|
59 label: 'Supported formats'
|
|
Chris@0
|
60 sequence:
|
|
Chris@0
|
61 type: string
|
|
Chris@0
|
62 label: 'Format'
|
|
Chris@0
|
63 authentication:
|
|
Chris@0
|
64 type: sequence
|
|
Chris@0
|
65 label: 'Supported authentication providers'
|
|
Chris@0
|
66 sequence:
|
|
Chris@0
|
67 type: string
|
|
Chris@0
|
68 label: 'Authentication provider'
|
|
Chris@0
|
69
|
|
Chris@0
|
70 rest_request:
|
|
Chris@0
|
71 type: mapping
|
|
Chris@0
|
72 mapping:
|
|
Chris@0
|
73 supported_formats:
|
|
Chris@0
|
74 type: sequence
|
|
Chris@0
|
75 label: 'Supported format'
|
|
Chris@0
|
76 sequence:
|
|
Chris@0
|
77 type: string
|
|
Chris@0
|
78 label: 'Format'
|
|
Chris@0
|
79 supported_auth:
|
|
Chris@0
|
80 type: sequence
|
|
Chris@0
|
81 label: 'Supported authentication'
|
|
Chris@0
|
82 sequence:
|
|
Chris@0
|
83 type: string
|
|
Chris@0
|
84 label: 'Authentication'
|
|
Chris@0
|
85
|
|
Chris@0
|
86 rest.resource.*:
|
|
Chris@0
|
87 type: config_entity
|
|
Chris@0
|
88 label: 'REST resource config'
|
|
Chris@0
|
89 mapping:
|
|
Chris@0
|
90 id:
|
|
Chris@0
|
91 type: string
|
|
Chris@0
|
92 label: 'REST resource config ID'
|
|
Chris@0
|
93 plugin_id:
|
|
Chris@0
|
94 type: string
|
|
Chris@0
|
95 label: 'REST resource plugin id'
|
|
Chris@0
|
96 granularity:
|
|
Chris@0
|
97 type: string
|
|
Chris@0
|
98 label: 'REST resource configuration granularity'
|
|
Chris@0
|
99 configuration:
|
|
Chris@0
|
100 type: rest_resource.[%parent.granularity]
|
|
Chris@0
|
101 label: 'REST resource configuration'
|
