rest.schema.yml

Same filename in other branches
  1. 9 core/modules/rest/config/schema/rest.schema.yml
  2. 10 core/modules/rest/config/schema/rest.schema.yml
  3. 11.x core/modules/rest/config/schema/rest.schema.yml
core/modules/rest/config/schema/rest.schema.yml

File

core/modules/rest/config/schema/rest.schema.yml

View source 
  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.     # @see https://www.drupal.org/node/2830467

  8.     link_domain:

  9.       type: string

  10.       label: 'Domain of the relation'

  11.     bc_entity_resource_permissions:

  12.       type: boolean

  13.       label: 'Whether the pre Drupal 8.2.x behavior of having permissions for EntityResource is enabled or not.'

  14. 

  15. # Method-level granularity of REST resource configuration.

  16. rest_resource.method:

  17.   type: mapping

  18.   mapping:

  19.     HEAD:

  20.       type: rest_request

  21.       label: 'HEAD method settings'

  22.     GET:

  23.       type: rest_request

  24.       label: 'GET method settings'

  25.     POST:

  26.       type: rest_request

  27.       label: 'POST method settings'

  28.     PUT:

  29.       type: rest_request

  30.       label: 'PUT method settings'

  31.     DELETE:

  32.       type: rest_request

  33.       label: 'DELETE method settings'

  34.     TRACE:

  35.       type: rest_request

  36.       label: 'TRACE method settings'

  37.     OPTIONS:

  38.       type: rest_request

  39.       label: 'OPTIONS method settings'

  40.     CONNECT:

  41.       type: rest_request

  42.       label: 'CONNECT method settings'

  43.     PATCH:

  44.       type: rest_request

  45.       label: 'PATCH method settings'

  46. 

  47. # Resource-level granularity of REST resource configuration.

  48. rest_resource.resource:

  49.   type: mapping

  50.   mapping:

  51.     methods:

  52.       type: sequence

  53.       label: 'Supported methods'

  54.       sequence:

  55.         type: string

  56.         label: 'HTTP method'

  57.     formats:

  58.       type: sequence

  59.       label: 'Supported formats'

  60.       sequence:

  61.         type: string

  62.         label: 'Format'

  63.     authentication:

  64.       type: sequence

  65.       label: 'Supported authentication providers'

  66.       sequence:

  67.         type: string

  68.         label: 'Authentication provider'

  69. 

  70. rest_request:

  71.   type: mapping

  72.   mapping:

  73.     supported_formats:

  74.       type: sequence

  75.       label: 'Supported format'

  76.       sequence:

  77.         type: string

  78.         label: 'Format'

  79.     supported_auth:

  80.       type: sequence

  81.       label: 'Supported authentication'

  82.       sequence:

  83.         type: string

  84.         label: 'Authentication'

  85. 

  86. rest.resource.*:

  87.   type: config_entity

  88.   label: 'REST resource config'

  89.   mapping:

  90.     id:

  91.       type: string

  92.       label: 'REST resource config ID'

  93.     plugin_id:

  94.       type: string

  95.       label: 'REST resource plugin id'

  96.     granularity:

  97.       type: string

  98.       label: 'REST resource configuration granularity'

  99.     configuration:

  100.       type: rest_resource.[%parent.granularity]

  101.       label: 'REST resource configuration'

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.