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. # 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. # Resource-level granularity of REST resource configuration.
  46. rest_resource.resource:
  47. type: mapping
  48. mapping:
  49. methods:
  50. type: sequence
  51. label: 'Supported methods'
  52. sequence:
  53. type: string
  54. label: 'HTTP method'
  55. formats:
  56. type: sequence
  57. label: 'Supported formats'
  58. sequence:
  59. type: string
  60. label: 'Format'
  61. authentication:
  62. type: sequence
  63. label: 'Supported authentication providers'
  64. sequence:
  65. type: string
  66. label: 'Authentication provider'
  67. rest_request:
  68. type: mapping
  69. mapping:
  70. supported_formats:
  71. type: sequence
  72. label: 'Supported format'
  73. sequence:
  74. type: string
  75. label: 'Format'
  76. supported_auth:
  77. type: sequence
  78. label: 'Supported authentication'
  79. sequence:
  80. type: string
  81. label: 'Authentication'
  82. rest.resource.*:
  83. type: config_entity
  84. label: 'REST resource config'
  85. mapping:
  86. id:
  87. type: string
  88. label: 'REST resource config ID'
  89. plugin_id:
  90. type: string
  91. label: 'REST resource plugin id'
  92. granularity:
  93. type: string
  94. label: 'REST resource configuration granularity'
  95. configuration:
  96. type: rest_resource.[%parent.granularity]
  97. label: 'REST resource configuration'

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