Merged in feature/jobcollector (pull request #30)
Initial Job Collector (changes pending) * movearroundtocleancollector * internalgetfunctions * completecollectorquery * simplify * fixtests * addvendor * noplaceholder
This commit is contained in:
@@ -156,32 +156,9 @@ paths:
|
||||
'400':
|
||||
description: Invalid request body.
|
||||
|
||||
/job-collectors:
|
||||
post:
|
||||
operationId: createJobCollector
|
||||
tags:
|
||||
- JobCollectorService
|
||||
summary: Create a job collector
|
||||
description: Creates a new job collector.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/JobCollectorCreate'
|
||||
responses:
|
||||
'201':
|
||||
description: Job collector created successfully.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/IdMessage'
|
||||
'400':
|
||||
description: Invalid request body.
|
||||
|
||||
/job-collectors/{id}:
|
||||
/job/{id}/collector:
|
||||
get:
|
||||
operationId: getJobCollectorById
|
||||
operationId: getJobCollectorByJobId
|
||||
tags:
|
||||
- JobCollectorService
|
||||
summary: Get a job collector by ID
|
||||
@@ -192,7 +169,7 @@ paths:
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The ID of the job collector to retrieve.
|
||||
description: The job ID for the collector.
|
||||
responses:
|
||||
'200':
|
||||
description: Job collector details.
|
||||
@@ -202,8 +179,8 @@ paths:
|
||||
$ref: '#/components/schemas/JobCollector'
|
||||
'404':
|
||||
description: Job collector not found.
|
||||
put:
|
||||
operationId: updateJobCollector
|
||||
patch:
|
||||
operationId: updateJobCollectorByJobId
|
||||
tags:
|
||||
- JobCollectorService
|
||||
summary: Update a job collector
|
||||
@@ -229,7 +206,7 @@ paths:
|
||||
'404':
|
||||
description: Job collector not found.
|
||||
|
||||
/export:
|
||||
/job/export:
|
||||
post:
|
||||
operationId: triggerExport
|
||||
tags:
|
||||
@@ -254,7 +231,7 @@ paths:
|
||||
'404':
|
||||
description: Job not found.
|
||||
|
||||
/export/{id}:
|
||||
/job/export/{id}:
|
||||
get:
|
||||
operationId: exportState
|
||||
tags:
|
||||
@@ -398,27 +375,76 @@ components:
|
||||
JobCollector:
|
||||
type: object
|
||||
properties:
|
||||
example_property:
|
||||
job_id:
|
||||
type: string
|
||||
description: Example property for JobCollector.
|
||||
description: The ID of the associated job.
|
||||
active_version:
|
||||
type: integer
|
||||
format: int32
|
||||
description: The active version of the collector.
|
||||
latest_version:
|
||||
type: integer
|
||||
format: int32
|
||||
description: The latest version of the collector.
|
||||
minimum_cleaner_version:
|
||||
type: integer
|
||||
format: int32
|
||||
description: The minimum version for the document cleaner.
|
||||
minimum_text_version:
|
||||
type: integer
|
||||
format: int32
|
||||
description: The minimum version for the text parser.
|
||||
fields:
|
||||
type: array
|
||||
description: The fields in the job collector.
|
||||
items:
|
||||
$ref: '#/components/schemas/JobCollectorField'
|
||||
description: JobCollector model.
|
||||
|
||||
JobCollectorCreate:
|
||||
type: object
|
||||
properties:
|
||||
example_property:
|
||||
type: string
|
||||
description: Example property for JobCollectorCreate.
|
||||
description: Payload for creating a JobCollector.
|
||||
required:
|
||||
- id
|
||||
- job_id
|
||||
- fields
|
||||
- minimum_cleaner_version
|
||||
- minimum_text_version
|
||||
- latest_version
|
||||
- active_version
|
||||
|
||||
JobCollectorUpdate:
|
||||
type: object
|
||||
properties:
|
||||
example_property:
|
||||
type: string
|
||||
description: Example property for JobCollectorUpdate.
|
||||
minimum_cleaner_version:
|
||||
type: integer
|
||||
format: int32
|
||||
description: The minimum version for the document cleaner.
|
||||
minimum_text_version:
|
||||
type: integer
|
||||
format: int32
|
||||
description: The minimum version for the text parser.
|
||||
active_version:
|
||||
type: integer
|
||||
format: int32
|
||||
description: The active version of the collector.
|
||||
fields:
|
||||
type: array
|
||||
description: The fields in the job collector.
|
||||
items:
|
||||
$ref: '#/components/schemas/JobCollectorField'
|
||||
description: Payload for updating a JobCollector.
|
||||
|
||||
JobCollectorField:
|
||||
type: object
|
||||
description: The field properties for the job collector.
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description: The output field name.
|
||||
query_id:
|
||||
type: string
|
||||
description: The query id that will populate the result.
|
||||
required:
|
||||
- name
|
||||
- query_id
|
||||
|
||||
ExportTrigger:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
Reference in New Issue
Block a user