Merged in feature/jobstatusendpoint (pull request #85)

Job Status Endpoint

* edpoint
This commit is contained in:
Michael McGuinness
2025-03-04 16:20:54 +00:00
parent d91ef1832b
commit a07037b018
9 changed files with 291 additions and 134 deletions
+39 -2
View File
@@ -277,6 +277,33 @@ paths:
"404":
description: Job not found.
/job/{id}/status:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: The job ID for the collector.
get:
operationId: getJobStatusByJobId
tags:
- JobCollectorService
summary: Get job status by job ID
description: Retrieves the job status by its job ID.
responses:
"200":
description: Job status details.
content:
application/json:
schema:
$ref: "#/components/schemas/JobStatusBody"
"400":
description: Invalid request parameters.
"404":
description: Job not found.
/job/{id}/collector:
parameters:
- in: path
@@ -545,12 +572,22 @@ components:
can_sync:
type: boolean
description: Specifies whether the job is actively syncing
status:
$ref: "#/components/schemas/JobStatus"
required:
- id
- client_id
- can_sync
JobStatusBody:
type: object
properties:
job_id:
type: string
format: uuid
description: The job id
status:
$ref: "#/components/schemas/JobStatus"
required:
- job_id
- status
JobCreate: