www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/rest/config/schema/rest.schema.yml

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