fix(docs): correctly document filter query usage
This commit is contained in:
@ -5257,7 +5257,7 @@ paths:
|
||||
name: s
|
||||
type: string
|
||||
- description: The sorting parameter. You can pass this multiple times to get
|
||||
the tasks ordered by multiple different parameters, along with `order_by`.
|
||||
the tasks ordered by multiple different parametes, along with `order_by`.
|
||||
Possible values to sort by are `id`, `title`, `description`, `done`, `done_at`,
|
||||
`due_date`, `created_by_id`, `project_id`, `repeat_after`, `priority`, `start_date`,
|
||||
`end_date`, `hex_color`, `percent_done`, `uid`, `created`, `updated`. Default
|
||||
@ -5270,27 +5270,15 @@ paths:
|
||||
in: query
|
||||
name: order_by
|
||||
type: string
|
||||
- description: The name of the field to filter by. Allowed values are all task
|
||||
properties. Task properties which are their own object require passing in
|
||||
the id of that entity. Accepts an array for multiple filters which will
|
||||
be chanied together, all supplied filter must match.
|
||||
- description: The filter query to match tasks by. Check out https://vikunja.io/docs/filters
|
||||
for a full explanation of the feature.
|
||||
in: query
|
||||
name: filter_by
|
||||
name: filter
|
||||
type: string
|
||||
- description: The value to filter for.
|
||||
- description: 'The time zone which should be used for date match (statements
|
||||
like '
|
||||
in: query
|
||||
name: filter_value
|
||||
type: string
|
||||
- description: The comparator to use for a filter. Available values are `equals`,
|
||||
`greater`, `greater_equals`, `less`, `less_equals`, `like` and `in`. `in`
|
||||
expects comma-separated values in `filter_value`. Defaults to `equals`
|
||||
in: query
|
||||
name: filter_comparator
|
||||
type: string
|
||||
- description: The concatinator to use for filters. Available values are `and`
|
||||
or `or`. Defaults to `or`.
|
||||
in: query
|
||||
name: filter_concat
|
||||
name: filter_timezone
|
||||
type: string
|
||||
- description: If set to true the result will include filtered fields whose
|
||||
value is set to `null`. Available values are `true` or `false`. Defaults
|
||||
@ -5298,6 +5286,14 @@ paths:
|
||||
in: query
|
||||
name: filter_include_nulls
|
||||
type: string
|
||||
- description: If set to `subtasks`, Vikunja will fetch only tasks which do
|
||||
not have subtasks and then in a second step, will fetch all of these subtasks.
|
||||
This may result in more tasks than the pagination limit being returned,
|
||||
but all subtasks will be present in the response. You can only set this
|
||||
to `subtasks`.
|
||||
in: query
|
||||
name: expand
|
||||
type: string
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
|
Reference in New Issue
Block a user