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. 

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

  34. rest_resource.resource:

  35.   type: mapping

  36.   mapping:

  37.     methods:

  38.       type: sequence

  39.       label: 'Supported methods'

  40.       sequence:

  41.         type: string

  42.         label: 'HTTP method'

  43.     formats:

  44.       type: sequence

  45.       label: 'Supported formats'

  46.       sequence:

  47.         type: string

  48.         label: 'Format'

  49.     authentication:

  50.       type: sequence

  51.       label: 'Supported authentication providers'

  52.       sequence:

  53.         type: string

  54.         label: 'Authentication provider'

  55. 

  56. rest_request:

  57.   type: mapping

  58.   mapping:

  59.     supported_formats:

  60.       type: sequence

  61.       label: 'Supported format'

  62.       sequence:

  63.         type: string

  64.         label: 'Format'

  65.     supported_auth:

  66.       type: sequence

  67.       label: 'Supported authentication'

  68.       sequence:

  69.         type: string

  70.         label: 'Authentication'

  71. 

  72. rest.resource.*:

  73.   type: config_entity

  74.   label: 'REST resource config'

  75.   mapping:

  76.     id:

  77.       type: string

  78.       label: 'REST resource config ID'

  79.     plugin_id:

  80.       type: string

  81.       label: 'REST resource plugin id'

  82.     granularity:

  83.       type: string

  84.       label: 'REST resource configuration granularity'

  85.     configuration:

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

  87.       label: 'REST resource configuration'

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