RequestInput #

KuzzleRequest input, normalizing a Kuzzle API call in JSON format.

This is the class used to build the input property of any KuzzleRequest object.

Technical information: github repository

Constructor #

new RequestInput(data);

Arguments	Type	Description
`data`	object	API request, in JSON format

The data object can contain the following properties:

Properties	Type	Description
`_id`	string	Resource unique identifier
`action`	string	Invoked API controller's action
`body`	object	KuzzleRequest specific data (document content, search queries, ...)
`collection`	string	Collection
`controller`	string	Invoked API controller
`index`	string	Index
`jwt`	string	Authentication token
`volatile`	object	KuzzleRequest volatile data
`...`	*	Unrecognized properties are considered request specific, and stored in the `args` object property

Properties	Type	Description
`action`	string	Invoked API controller's action
`args`	object	KuzzleRequest specific arguments
`body`	object	KuzzleRequest specific data
`controller`	string	Invoked API controller
`jwt`	string	Authentication token
`resource`	object	Stored resource target
`volatile`	object	KuzzleRequest volatile data

The resource property contains resources information: