Configuration - Outputs

outputs

Type: Array of Object.Each item in this array must match one of the following definitions.

An output defines the output format of the data, how to search for it, and any relationship between it.

Example:

outputs:
  - name: venuesList
    type: jsonArray
    input: venues
    parameters:
      city:
        property: city
        index: venueAddress
        parser: string
  - name: venue
    type: jsonObject
    input: venues
    parameters:
      id:
        property: id
        index: venueIds
        parser: integer

JSON Object

outputs[type = “jsonObject”]

Type: Object

This output produces a JSON document whose root is an object containing all the properties fetched from the input. The object is found in the input by filtering the specified parameters. Objects from any input can also be embedded as a relationship.

Examples:

name: venue
type: jsonObject
input: venues
parameters:
  id:
    property: id
    index: venueIds
    parser: integer

name: singleUserById
type: jsonObject
input: users
parameters:
  id:
    property: id
    index: userIds
    parser: integer
relationships:
  role:
    input: roles
    match:
      - parentProperty: roleId
        childProperty: id
        childIndex: roleIds
    sort:
      - property: id
        ascending: true

Properties:

name

outputs[type = “jsonObject”].name

Type: String

The name of this output, which any other component will use to refer to it.

type

outputs[type = “jsonObject”].type

Must have the value: "jsonObject"

input

outputs[type = “jsonObject”].input

Type: String

The name of the input from which the data will be fetched.

parameters

outputs[type = “jsonObject”].parameters

Type: Object

relationships (optional)

outputs[type = “jsonObject”].relationships

Type: Object

JSON Array

outputs[type = “jsonArray”]

Type: Object

This output produces a JSON array whose items are objects fetched from the input. The objects are found in the input by filtering the specified parameters. Objects from any input can also be embedded as a relationship. There is an always-enabled and configurable paging to this array.

Examples:

name: venuesList
type: jsonArray
input: venues
parameters:
  city:
    property: city
    index: venueAddress
    parser: string

name: userList
type: jsonArray
input: users
parameters:
  name:
    property: name
    index: userInfo
    parser: string
limit:
  default: 10
  max: 100
  parameter: "pageLimit"
offset:
  parameter: "pageOffset"
relationships:
  role:
    input: roles
    match:
      - parentProperty: roleId
        childProperty: id
        childIndex: roleIds
    sort:
      - property: id
        ascending: true