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

Update OpenAPI spec #1522

Merged
merged 1 commit into from
Aug 1, 2024
Merged
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
27 changes: 27 additions & 0 deletions turbinia/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -667,6 +667,33 @@ paths:
summary: Get Task Output
tags:
- Turbinia Request Results
/api/task/report/{task_id}:
get:
description: "Retrieves the MarkDown report of a Turbinia task.\n\nRaises:\n\
\ HTTPException: if another exception is caught."
operationId: get_task_report
parameters:
- in: path
name: task_id
required: true
schema:
title: Task Id
type: string
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get Task Report
tags:
- Turbinia Tasks
/api/task/statistics:
get:
description: "Retrieves statistics for Turbinia execution.\n\nArgs:\n days\
Expand Down