Data and Job Handling API OAS3 schema errors

APIs & Connectors
1

Dear Visier developer community,

After starting to use the Data and Job Handling API we have found out that the OAS3 schema provided here has invalid definitions for some of the endpoints in the API. For instance the endpoint GET /v1/op/jobs/dispatching-jobs/{jobId} (here’s the line in the OAS3 schema) is specified as /v1/op/jobs/dispatching-jobs/:jobId:, which is invalid. According to the OAS3 specified here, path parameters are defined in curly braces and specified in the parameters section as:

- in: path
  name: jobId
  schema:
     type: string
  required: true
  description: The ID of the job you want to retrieve

These errors in the OAS3 file hinder us to auto-generate a HTTP client without further intervention. For the time being we have removed these errors, in order to generate a usable HTTP client.

There are multiple errors in the OAS3 file, which need to be addresed. Here are the few of them:

  1. GET /v1/op/jobs/dispatching-jobs/{jobId}/extraction-jobs
  2. GET /v1/op/jobs/dispatching-jobs/{jobId}/processing-jobs
  3. etc.

Could you please remove these errors in the OAS3 file and also review the other APIs (e.g. Tenant API).

Thanks in advance,

2

Hello @b.zafirov,

Thanks for raising this. We’ve created a ticket and I will update this thread with more information as I receive it.

Thanks!

Ike

3

Hello,
Please note that this issue was addressed here.

Thanks,
/Henrik

4

Hello Henrik,

There’s still a bug in the OAS3 schema for the endpoint DELETE /v1/op/data-connector-credentials/{id}, namely for the id parameter the following line has to be added:

required: true

This is the line in the OAS3 spec.

Furthermore, the endpoint GET /v1/op/jobs/dispatching-jobs/{jobId}/processing-jobs contains the query parameter dispatchingJobId, which I think is obsolete/redundant. You can find it in the OAS3 spec on this line.

Best regards

5

Hello @b.zafirov ,
Confirmed the bug with the missing required: true for the delete endpoint. This will be fixed.

As for the dispatchingJobId, that is a valid query string argument for this API. Think of it as a parent Job filter to get specific processing jobs.

Thanks,
/Henrik

1 Like