diff --git a/docs/openapi3.yaml b/docs/openapi3.yaml index 657be313d..ad8cc73dc 100644 --- a/docs/openapi3.yaml +++ b/docs/openapi3.yaml @@ -27,7 +27,7 @@ tags: Tests include end-to-end scenarios that are executed at pre-configured intervals to provide in-depth performance metrics of your API. - name: Processors description: | - Processor files allow Predator to execute custom javascript code during test flows. + Processor file allows Preadtor execute custom javascript code. - name: Jobs description: | Predator executes tests through so-called **jobs**. Depending on your configuration, the job will either execute immediately or at scheduled intervals. @@ -877,9 +877,10 @@ paths: name: limit description: The number of most recent reports to retrieve. required: true - minimum: 1 - maximum: 250 - type: integer + schema: + minimum: 1 + maximum: 250 + type: integer responses: '200': description: Success @@ -1059,12 +1060,11 @@ paths: parameters: - in: query name: from - description: From which result to start retrieve data + description: From which result to start retrieve data ( default is zero ) required: false schema: type: integer minimum: 0 - default: 0 - in: query name: limit description: Max results to return from this query ( Limit to 100 ) @@ -1072,7 +1072,6 @@ paths: schema: type: integer maximum: 100 - default: 100 responses: '200': description: Success @@ -1205,41 +1204,6 @@ paths: application/json: schema: $ref: '#/components/schemas/error_response' - '/v1/processors/{processor_id}/download': - post: - operationId: update-processor-file-content - tags: - - Processors - summary: Download the file and update its javascript content. - description: Download the file from the 'file_url' configured for the processor and update its javascript content. If download fails, keep the original javascript content without overriding it. - parameters: - - in: path - name: processor_id - description: The id of the processor file to download. - required: true - schema: - type: string - responses: - '204': - description: Success - '400': - description: Bad request - content: - application/json: - schema: - $ref: '#/components/schemas/error_response' - '404': - description: Not found - content: - application/json: - schema: - $ref: '#/components/schemas/error_response' - '500': - description: Internal server error - content: - application/json: - schema: - $ref: '#/components/schemas/error_response' components: parameters: @@ -1330,6 +1294,7 @@ components: format: uri example: http://www.example.com/file.txt description: Url to text file location , will be used by the processor + description: type: string description: A description of the test. @@ -1727,8 +1692,8 @@ components: discriminator: propertyName: type oneOf: - - $ref: '#/components/schemas/file_download' - - $ref: '#/components/schemas/raw_javascript' + - $ref: '#/components/schemas/download' + - $ref: '#/components/schemas/raw' required: - name - description @@ -1750,17 +1715,17 @@ components: readOnly: true updated_at: type: string - format: date-time + format: date_time description: The date and time that the procesor file was updated. readOnly: true created_at: type: string - format: date-time + format: date_time description: The date and time that the procesor file was created. readOnly: true javascript: type: string - description: Raw javascript that will be used by the processor resource. + description: Javascript raw that will be used by the processor resource. readOnly: true post_report: required: @@ -1992,7 +1957,7 @@ components: timeout: description: timout to smtp server in milliseconds type: number - file_download: + download: description: Download processor file from the file_url and store it. required: - file_url @@ -2000,7 +1965,10 @@ components: file_url: type: string description: url that the file can be downloaded from, should be direct download link. - raw_javascript: + force_download: + type: boolean + description: wether to try download the file_url on every invoke by a test. + raw: description: Javascript file that will be used by the processor resource. required: - javascript @@ -2012,5 +1980,9 @@ components: type: string description: | The type of the processor resource. Can be one of the following: - * `raw_javascript`: Raw javascript string that will be stored and persisted as it is. - * `file_download`: Predator will download the custom javascript by file_url and persist it. \ No newline at end of file + * `raw`: Raw javascript string that will be stored and persisted as it is. + * `download`: Predator will download the custom javascript by file_url and persist it. + enum: + - dsl + - basic + example: dsl \ No newline at end of file