This repository has been archived by the owner on Nov 30, 2022. It is now read-only.
Document new saas param configs: options
, multiselect
and unpack
#1286
Labels
documentation
Improvements or additions to documentation
Docs Update Description
#1253 adds a few new options to parameters in SaaS configs:
A
connector_param
, can now have:options
field, which defines a set (enumeration) of values that are allowed for the given param. Providing a value that's outside of this set will result in a configuration error.multiselect
field, which can only be used ifoptions
is defined on the same param.multiselect
indicates that multiple values from the definedoptions
enumeration may be used on any given parameterization, provided as an array. it defaults toFalse
.A request's
param_value
has the new field:unpack
, a boolean which defaults toFalse
indicating that the values must be unpacked from a list/array before being used to generate the requests. This means that a list ofn
elements will result inn
distinct requests for the given traversal. The primary use case driving this option is one-to-many relationships, e.g. a givenuser
record is associated withn
mailing lists, and theusers
collection has a multi-valuelist_ids
field pointing to the IDs of these lists. Each request to themailing_lists
endpoint takes only a singlelist_id
as a param value, but thereference
from theusers
collection will resolve to an array ofn
values for any givenuser
record. Upon traversing from theusers
endpoint to themailing_lists
endpoint, fidesops mustunpack
the array ofn
values in thelist_id
field inton
requests to themailing_lists
endpoint, each with a singlelist_id
from the array.Additional context
See updates to
saas_example_config.yml
andsaas_example_dataset.yml
from the PR for examples of the new functionality being configuredThe text was updated successfully, but these errors were encountered: