# Data and Job Handling API OAS3 schema errors

**URL:** <https://visier.discourse.group/t/data-and-job-handling-api-oas3-schema-errors/249>\
**Category:** APIs & Connectors\
**Created:** [April 25, 2024, 4:43pm UTC](https://visier.discourse.group/t/data-and-job-handling-api-oas3-schema-errors/249 "2024-04-25T16:43:56Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![b.zafirov](https://avatars.discourse-cdn.com/v4/letter/b/ce7236/32.png) [@b.zafirov](https://visier.discourse.group/u/b.zafirov)\
**Post date:** [April 25, 2024, 4:43pm UTC](https://visier.discourse.group/t/data-and-job-handling-api-oas3-schema-errors/249/1 "2024-04-25T16:43:56Z")

</div>

Dear Visier developer community,

After starting to use the Data and Job Handling API we have found out that the OAS3 schema provided [here](https://github.com/visier/openapi-clients/blob/main/res/data-handling-apis.yaml) has invalid definitions for some of the endpoints in the API. For instance the endpoint `GET /v1/op/jobs/dispatching-jobs/{jobId}` ([here’s](https://github.com/visier/openapi-clients/blob/main/res/data-handling-apis.yaml#L509C3-L509C39) the line in the OAS3 schema) is specified as `/v1/op/jobs/dispatching-jobs/:jobId:`, which is invalid. According to the OAS3 specified [here](https://swagger.io/docs/specification/describing-parameters/), path parameters are defined in curly braces and specified in the `parameters` section as:

```yaml
- 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](https://github.com/visier/openapi-clients/blob/main/res/data-handling-apis.yaml#L535)
2. [GET /v1/op/jobs/dispatching-jobs/{jobId}/processing-jobs](https://github.com/visier/openapi-clients/blob/main/res/data-handling-apis.yaml#L587)
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,

---

<div class="post-metadata">

**Author:** ![ike.bennion](https://yyz1.discourse-cdn.com/flex035/user_avatar/visier.discourse.group/ike.bennion/32/9_2.png) [@ike.bennion](https://visier.discourse.group/u/ike.bennion)\
**Post date:** [April 26, 2024, 12:11am UTC](https://visier.discourse.group/t/data-and-job-handling-api-oas3-schema-errors/249/2 "2024-04-26T00:11:56Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![henrik.areskoug](https://avatars.discourse-cdn.com/v4/letter/h/85f322/32.png) [@henrik.areskoug](https://visier.discourse.group/u/henrik.areskoug)\
**Post date:** [May 2, 2024, 8:17pm UTC](https://visier.discourse.group/t/data-and-job-handling-api-oas3-schema-errors/249/3 "2024-05-02T20:17:27Z")

</div>

Hello,  
Please note that this issue was addressed [here](https://visier.discourse.group/t/update-user-api-has-incorrect-oas3-definition/251/2).

Thanks,  
/Henrik

---

<div class="post-metadata">

**Author:** ![b.zafirov](https://avatars.discourse-cdn.com/v4/letter/b/ce7236/32.png) [@b.zafirov](https://visier.discourse.group/u/b.zafirov)\
**Post date:** [May 7, 2024, 9:49am UTC](https://visier.discourse.group/t/data-and-job-handling-api-oas3-schema-errors/249/4 "2024-05-07T09:49:58Z")

</div>

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:

```yaml
required: true

```

[This](https://github.com/visier/openapi-clients/blob/main/res/data-handling-apis.yaml#L813) 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](https://github.com/visier/openapi-clients/blob/main/res/data-handling-apis.yaml#L606).

Best regards

---

<div class="post-metadata">

**Author:** ![henrik.areskoug](https://avatars.discourse-cdn.com/v4/letter/h/85f322/32.png) [@henrik.areskoug](https://visier.discourse.group/u/henrik.areskoug)\
**Post date:** [May 9, 2024, 12:04am UTC](https://visier.discourse.group/t/data-and-job-handling-api-oas3-schema-errors/249/5 "2024-05-09T00:04:50Z")

</div>

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