You are here

Home » API reference » JSON:API Extras 8.3

jsonapi_extras.schema.yml in JSON:API Extras 8.3

Same filename and directory in other branches
  1. 8 config/schema/jsonapi_extras.schema.yml
  2. 8.2 config/schema/jsonapi_extras.schema.yml
config/schema/jsonapi_extras.schema.yml

File

config/schema/jsonapi_extras.schema.yml
View source 
  1. jsonapi_extras.jsonapi_resource_config.*:

  2.   type: config_entity

  3.   label: 'JSON:API Resource Config'

  4.   mapping:

  5.     id:

  6.       type: string

  7.       label: 'Original Resource ID.'

  8.     disabled:

  9.       type: boolean

  10.       label: 'Disabled'

  11.       description: 'Is the resource disabled?'

  12.     path:

  13.       type: string

  14.       label: 'Path'

  15.       description: 'The path for the resource.'

  16.     resourceType:

  17.       type: string

  18.       label: 'Type'

  19.       description: 'The value for the resource type.'

  20.     resourceFields:

  21.       type: sequence

  22.       label: 'Fields'

  23.       sequence:

  24.         type: jsonapi_extras.resource_field

  25. 

  26. jsonapi_extras.resource_field:

  27.   type: mapping

  28.   mapping:

  29.     disabled:

  30.       type: boolean

  31.       label: 'Disabled'

  32.       description: 'Is the field disabled?'

  33.     fieldName:

  34.       type: string

  35.       label: 'Entity field name'

  36.     publicName:

  37.       type: string

  38.       label: 'Public attribute name'

  39.     enhancer:

  40.       type: mapping

  41.       label: 'Enhancer plugin'

  42.       description: 'A plugin that carries additional (de)normalization tasks.'

  43.       mapping:

  44.         id:

  45.           type: string

  46.           description: 'The enhancer plugin ID'

  47.         settings:

  48.           type: jsonapi_extras.enhancer_plugin.[%parent.id]

  49. 

  50. jsonapi_extras.enhancer_plugin.date_time:

  51.   type: mapping

  52.   mapping:

  53.     dateTimeFormat:

  54.       type: string

  55. 

  56. jsonapi_extras.enhancer_plugin.nested:

  57.   type: mapping

  58.   mapping:

  59.     path:

  60.       type: string

  61. 

  62. jsonapi_extras.settings:

  63.   type: config_object

  64.   label: 'JSON:API Extras settings'

  65.   mapping:

  66.     path_prefix:

  67.       type: string

  68.       label: 'Path prefix'

  69.       description: 'The path prefix for JSON:API'

  70.     include_count:

  71.       type: boolean

  72.       label: 'Include count in collection responses'

  73.       description: 'If activated, all collection responses will return a total record count for the provided query.'