Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property
Description
Mandatory

name

The name of the transformer to apply.

Yes
phase

Defines if the transformer is to be applied to (PUT, POST, PATCH) requests the request or to GET responsesthe response

Valid values are "REQUEST" or "RESPONSE".

Yes
scope

Defines if the transformer is to be applied to the resource where it is defined or its children.

"THIS" or "CHILDREN".The scope applies to RESPONSE transformers; with SCOPE="THIS" transformer is executed once on the whole response, with SCOPE="children" it is executed once per each children resource.

For instance, with scope="THIS"

GET /db/coll is executed once
GET /db/coll/docid is executed once

with scope="CHILDREN"

GET /db/coll is executed once per each embedded document
GET /db/coll/docid is executed once
Yes
argsarguments to be passed to the transformer.No

...