Excluding APD rules from Cloud API entity schema responses
You can exclude specific APD rules from entity schema responses.
To configure exclusions, open Studio and create one or more files that end with .exclusions.yaml in the config/integration/schemaruleexclusions directory.
The exclusions file must contain a top-level exclusions property. This
property is an array of objects.
For example, the exclusions file format looks like
this:
exclusions:
- ruleOwner: product.lines[TSTLine].fields[ConditionalProperty]
ruleType: min
- ruleOwner: product.lines[TSTLine].coverages[LineCovWCovTermsAndTags].terms[OptionCovTermWithTags]
ruleType: existence
choiceCode: 100
editionCodes: ["BaseEdition", "EditionA"]You can configure the following properties to define each exclusion in the file:
| Property | Description |
|---|---|
| ruleOwner | Required. The APD path to the element that the rule attaches to, or the parent field or term if the rule applies to a typekey, option, or package. |
| ruleType | Required. The type of rule the exclusion applies to. Valid values
are: existence, min,
max, default, or
tag. |
| choiceCode | Optional. If the rule applies to an existence or tag rule on a typekey, option, or package, this is the code of the specific choice that the rule applies to. For monetary options or packages, this must match the APD code and not include the currency suffix. |
| editionCodes | Optional. If you omit this property or leave it empty, the exclusion applies to all editions. If you include this property, the exclusion applies only to the listed edition codes |