rest.schema.yml

Same filename in other branches
  1. 8.9.x 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. # Method-level granularity of REST resource configuration.
  2. rest_resource.method:
  3. type: mapping
  4. mapping:
  5. HEAD:
  6. type: rest_request
  7. label: 'HEAD method settings'
  8. GET:
  9. type: rest_request
  10. label: 'GET method settings'
  11. POST:
  12. type: rest_request
  13. label: 'POST method settings'
  14. PUT:
  15. type: rest_request
  16. label: 'PUT method settings'
  17. DELETE:
  18. type: rest_request
  19. label: 'DELETE method settings'
  20. TRACE:
  21. type: rest_request
  22. label: 'TRACE method settings'
  23. OPTIONS:
  24. type: rest_request
  25. label: 'OPTIONS method settings'
  26. CONNECT:
  27. type: rest_request
  28. label: 'CONNECT method settings'
  29. PATCH:
  30. type: rest_request
  31. label: 'PATCH method settings'
  32. # Resource-level granularity of REST resource configuration.
  33. rest_resource.resource:
  34. type: mapping
  35. mapping:
  36. methods:
  37. type: sequence
  38. label: 'Supported methods'
  39. sequence:
  40. type: string
  41. label: 'HTTP method'
  42. formats:
  43. type: sequence
  44. label: 'Supported formats'
  45. sequence:
  46. type: string
  47. label: 'Format'
  48. authentication:
  49. type: sequence
  50. label: 'Supported authentication providers'
  51. sequence:
  52. type: string
  53. label: 'Authentication provider'
  54. rest_request:
  55. type: mapping
  56. mapping:
  57. supported_formats:
  58. type: sequence
  59. label: 'Supported format'
  60. sequence:
  61. type: string
  62. label: 'Format'
  63. supported_auth:
  64. type: sequence
  65. label: 'Supported authentication'
  66. sequence:
  67. type: string
  68. label: 'Authentication'
  69. rest.resource.*:
  70. type: config_entity
  71. label: 'REST resource config'
  72. mapping:
  73. id:
  74. type: string
  75. label: 'REST resource config ID'
  76. plugin_id:
  77. type: string
  78. label: 'REST resource plugin id'
  79. granularity:
  80. type: string
  81. label: 'REST resource configuration granularity'
  82. configuration:
  83. type: rest_resource.[%parent.granularity]
  84. label: 'REST resource configuration'

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