Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(functions): expand xor function and add exclusive option for or functionality #2616

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
+404 −33
Open

feat(functions): expand xor function and add exclusive option for or functionality #2616

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b51741e
Expand XOR function to any number of properties, add similar OR function
cuttingclyde May 1, 2024
443ffbd
Use original language: Communicate
cuttingclyde May 2, 2024
56e06bf
Add unmentioned property to tests
cuttingclyde May 2, 2024
da5f5a3
Merge branch 'develop' of github.com:cuttingclyde/spectral into featu…
cuttingclyde May 3, 2024
61945dc
Replace new function with (default true) option on function
cuttingclyde May 4, 2024
d8eec32
Update packages/functions/src/xor.ts
cuttingclyde May 20, 2024
d55f31d
Update packages/functions/src/xor.ts
cuttingclyde May 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/reference/functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,23 +247,25 @@ unused-definition:

## xor

Communicate that one of these properties is required, and no more than one is allowed to be defined.
Communicate that one of these properties is required, and exactly one or more than one is allowed to be defined, depending on `exclusive` option. FunctionOptions must contain any non-zero number of properties, `exclusive: true` (the default) requires that _exactly_ one of them is defined, `exclusive: false` requires that _at least_ one but possibly more than one is defined. (For only one property specified, `exclusive` is not relevant and this is the same as the `defined` function for the single property.)

<!-- title: functionOptions -->

| name | description | type | required? |
| ---------- | ----------------------- | ---------- | --------- |
| properties | the properties to check | `string[]` | yes |
| name | description | type | required? |
| ---------- | ------------------------------------------------------------------------------------------- | ---------- | --------- |
| properties | the properties to check | `string[]` | yes |
| exclusive | `true` by default for `xor`; when not truthy multiple matches are allowed for `or` behavior | `boolean` | no |

<!-- title: example -->

```yaml
components-examples-value-or-externalValue:
description: Examples should have either a `value` or `externalValue` field.
description: Examples should have either a `value` or `externalValue` field, but not both; unless `exclusive` is false
given: "$.components.examples.*"
then:
function: xor
functionOptions:
exclusive: false
properties:
- externalValue
- value
Expand Down
Loading