You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Task:
type: objectproperties:
id:
readOnly: truetype: stringorgID:
description: The ID of the organization that owns this Task.type: stringorg:
description: The name of the organization that owns this Task.type: stringname:
description: The name of the task.type: stringdescription:
description: An optional description of the task.type: stringstatus:
description: The current status of the task. When updated to 'inactive', cancels all queued jobs of this task.default: activetype: stringenum:
- active
- inactivelabels:
$ref: "#/components/schemas/Labels"authorizationID:
description: The ID of the authorization used when this task communicates with the query engine.type: stringflux:
description: The Flux script to run for this task.type: stringevery:
description: A simple task repetition schedule; parsed from Flux.type: stringcron:
description: A task repetition schedule in the form '* * * * * *'; parsed from Flux.type: stringoffset:
description: Duration to delay after the schedule, before executing the task; parsed from flux, if set to zero it will remove this option and use 0 as the default.type: stringlatestCompleted:
description: Timestamp of latest scheduled, completed run, RFC3339.type: stringformat: date-timereadOnly: truecreatedAt:
type: stringformat: date-timereadOnly: trueupdatedAt:
type: stringformat: date-timereadOnly: truelinks:
type: objectreadOnly: trueexample:
self: "/api/v2/tasks/1"owners: "/api/v2/tasks/1/owners"members: "/api/v2/tasks/1/members"labels: "/api/v2/tasks/1/labels"runs: "/api/v2/tasks/1/runs"logs: "/api/v2/tasks/1/logs"properties:
self:
$ref: "#/components/schemas/Link"owners:
$ref: "#/components/schemas/Link"members:
$ref: "#/components/schemas/Link"runs:
$ref: "#/components/schemas/Link"logs:
$ref: "#/components/schemas/Link"labels:
$ref: "#/components/schemas/Link"required: [id, name, orgID, flux]
but the TaskCreateRequest and TaskUpdateRequest doesn't have a description field:
TaskCreateRequest:
type: objectproperties:
orgID:
description: The ID of the organization that owns this Task.type: stringorg:
description: The name of the organization that owns this Task.type: stringstatus:
description: Starting state of the task. 'inactive' tasks are not run until they are updated to 'active'default: activetype: stringenum:
- active
- inactiveflux:
description: The Flux script to run for this task.type: stringtoken:
description: The token to use for authenticating this task when it executes queries. If omitted, uses the token associated with the request that creates the task.type: stringrequired: [flux]TaskUpdateRequest:
type: objectproperties:
status:
description: Starting state of the task. 'inactive' tasks are not run until they are updated to 'active'default: activetype: stringenum:
- active
- inactiveflux:
description: The Flux script to run for this task.type: stringname:
description: Override the 'name' option in the flux script.type: stringevery:
description: Override the 'every' option in the flux script.type: stringcron:
description: Override the 'cron' option in the flux script.type: stringoffset:
description: Override the 'offset' option in the flux script.type: stringtoken:
description: Override the existing token associated with the task.type: string
so there is no option how to set description to Task because create and update is defined as:
/tasks:
post:
tags:
- Taskssummary: Create a new taskparameters:
- $ref: '#/components/parameters/TraceSpan'requestBody:
description: task to createrequired: truecontent:
application/json:
schema:
$ref: "#/components/schemas/TaskCreateRequest"responses:
'201':
description: Task createdcontent:
application/json:
schema:
$ref: "#/components/schemas/Task"default:
description: unexpected errorcontent:
application/json:
schema:
$ref: "#/components/schemas/Error"'/tasks/{taskID}':
patch:
tags:
- Taskssummary: Update a taskdescription: Update a task. This will cancel all queued runs.requestBody:
description: task update to applyrequired: truecontent:
application/json:
schema:
$ref: "#/components/schemas/TaskUpdateRequest"parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: pathname: taskIDschema:
type: stringrequired: truedescription: ID of task to getresponses:
'200':
description: task updatedcontent:
application/json:
schema:
$ref: "#/components/schemas/Task"default:
description: unexpected errorcontent:
application/json:
schema:
$ref: "#/components/schemas/Error"
The
Task
is defined withdescription
field:but the
TaskCreateRequest
andTaskUpdateRequest
doesn't have adescription
field:so there is no option how to set
description
toTask
because create and update is defined as:introduced by #13850, cc @AlirieGray, @jademcgough
The text was updated successfully, but these errors were encountered: