Skip to content

Commit 4e2084f

Browse files
authored
niuser: Clean up query documentation
YAML folds line breaks, so you need to double-space to get a new line and triple-space to form paragraphs
1 parent 31c984c commit 4e2084f

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

user/niuser.yaml

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,27 +362,52 @@ parameters:
362362
The filter criteria for users, consisting of a string of queries composed using AND/OR operators.
363363
String values need to be enclosed in double quotes.
364364
Parenthesis can be used within the filter to better define the order of operations.
365+
366+
365367
Filter syntax: '[property name][operator][operand] and [property name][operator][operand]'
368+
369+
366370
Operators:
371+
367372
- Equals operator '='. Example: 'x = y'
373+
368374
- Not equal operator '!='. Example: 'x != y'
375+
369376
- Greater than operator '>'. Example: 'x > y'
377+
370378
- Greater than or equal operator '>='. Example: 'x >= y'
379+
371380
- Less than operator '<'. Example: 'x < y'
381+
372382
- Less than or equal operator '<='. Example: 'x <= y'
383+
373384
- Logical AND operator 'and'. Example: 'x and y'
385+
374386
- Logical OR operator 'or'. Example: 'x or y'
387+
375388
- Contains operator '.Contains()', used to check whether a string contains another string. Example: 'x.Contains(y)'
389+
376390
- Does not contain operator '!.Contains()', used to check whether a string does not contain another string. Example: '!x.Contains(y)'
391+
377392
- String null or empty 'string.IsNullOrEmpty()', used to check whether a string is null or empty. Example: 'string.IsNullOrEmpty(x)'
393+
378394
- String is not null or empty '!string.IsNullOrEmpty()', used to check whether a string is not null or empty. Example: '!string.IsNullOrEmpty(x)'
395+
396+
379397
Valid user properties that can be used in the filter:
398+
380399
- id
400+
381401
- firstName
402+
382403
- lastName
404+
383405
- email
406+
384407
- niuaId
408+
385409
- login
410+
386411
- status
387412
type: string
388413
example: firstName.Contains("John") && status == "active"
@@ -879,4 +904,4 @@ definitions:
879904
enum: ['UserWorkspacesCreatedRoutedMessage']
880905
example: UserWorkspacesCreatedRoutedMessage
881906
workspace:
882-
$ref: '#/definitions/Workspace'
907+
$ref: '#/definitions/Workspace'

0 commit comments

Comments
 (0)