Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: added task status api #28

Merged
merged 8 commits into from
Aug 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions openapi3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,44 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/internalError'
/taskStatus/{jobId}:
get:
tags:
- tasks
summary: Get task status by job id
operationId: getTaskStatusByJobId
parameters:
- name: jobId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/getTaskStatusResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'404':
description: Could not find task with matched jobId
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/internalError'
components:
requestBodies:
ExportGetmapBody:
Expand Down Expand Up @@ -202,3 +240,20 @@ components:
description: >-
Bounding box corners (lower left, upper right)=[minx,miny,maxx,maxy] in
crs units as array
getTaskStatusResponse:
type: object
properties:
percentage:
type: number
minimum: 0
maximum: 100
description: percentage of task by job id
status:
type: string
enum:
- Completed
- In-Progress
- Pending
- Failed
- Expired
- Aborted
Loading