docs(api/v2): tag bulk task fields for the v2 schema
This commit is contained in:
parent
1aa9493bc3
commit
711545e9f2
|
|
@ -24,10 +24,10 @@ import (
|
||||||
|
|
||||||
// BulkTask represents a bulk task update payload.
|
// BulkTask represents a bulk task update payload.
|
||||||
type BulkTask struct {
|
type BulkTask struct {
|
||||||
TaskIDs []int64 `json:"task_ids"`
|
TaskIDs []int64 `json:"task_ids" doc:"The ids of the tasks to update. The user needs write access to every project these tasks belong to, or the whole request is rejected."`
|
||||||
Fields []string `json:"fields"`
|
Fields []string `json:"fields" doc:"The names of the task fields to apply from values; only these fields are written, the rest of each task is left untouched."`
|
||||||
Values *Task `json:"values"`
|
Values *Task `json:"values" doc:"The task carrying the values to set. Only the fields named in fields are read from it and applied to every task."`
|
||||||
Tasks []*Task `json:"tasks,omitempty"`
|
Tasks []*Task `json:"tasks,omitempty" readOnly:"true" doc:"The updated tasks, returned in the response."`
|
||||||
|
|
||||||
web.CRUDable `xorm:"-" json:"-"`
|
web.CRUDable `xorm:"-" json:"-"`
|
||||||
web.Permissions `xorm:"-" json:"-"`
|
web.Permissions `xorm:"-" json:"-"`
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue