update task swagger definition

pull/10616/head
zhulongcheng 2018-11-20 11:29:20 +08:00 committed by Mark Rushakoff
parent 3834744464
commit 631cb9a5f8
1 changed files with 38 additions and 16 deletions

View File

@ -2478,26 +2478,19 @@ paths:
name: user name: user
schema: schema:
type: string type: string
description: filter tasks to a specific user name description: filter tasks to a specific user ID
- in: query - in: query
name: org name: org
schema: schema:
type: string type: string
description: filter tasks to a specific organization name description: filter tasks to a specific organization ID
responses: responses:
'200': '200':
description: A list of tasks description: A list of tasks
content: content:
application/json: application/json:
schema: schema:
type: object $ref: "#/components/schemas/Tasks"
properties:
runs:
type: array
items:
$ref: "#/components/schemas/Tasks"
links:
$ref: "#/components/schemas/Links"
default: default:
description: unexpected error description: unexpected error
content: content:
@ -3750,11 +3743,12 @@ components:
description: Link to the full logs for a run. description: Link to the full logs for a run.
type: string type: string
Task: Task:
type: object
properties: properties:
id: id:
readOnly: true readOnly: true
type: string type: string
organization: organizationId:
description: The ID of the organization that owns this Task. description: The ID of the organization that owns this Task.
type: string type: string
name: name:
@ -3767,8 +3761,6 @@ components:
enum: enum:
- active - active
- inactive - inactive
owners:
$ref: "#/components/schemas/Owners"
flux: flux:
description: The Flux script to run for this task. description: The Flux script to run for this task.
type: string type: string
@ -3778,11 +3770,41 @@ components:
cron: cron:
description: A task repetition schedule in the form '* * * * * *'; parsed from Flux. description: A task repetition schedule in the form '* * * * * *'; parsed from Flux.
type: string type: string
links:
type: object
readOnly: true
example:
self: "/api/v2/tasks/1"
owners: "/api/v2/tasks/1/owners"
members: "/api/v2/tasks/1/members"
runs: "/api/v2/tasks/1/runs"
logs: "/api/v2/tasks/1/logs"
properties:
self:
type: string
format: uri
owners:
type: string
format: uri
members:
type: string
format: uri
runs:
type: string
format: uri
logs:
type: string
format: uri
required: [name, organization, flux] required: [name, organization, flux]
Tasks: Tasks:
type: array type: object
items: properties:
$ref: "#/components/schemas/Task" tasks:
type: array
items:
$ref: "#/components/schemas/Task"
links:
$ref: "#/components/schemas/Links"
UserResponse: UserResponse:
type: object type: object
properties: properties: