cancel
Showing results for 
Search instead for 
Did you mean: 
Data Engineering
Join discussions on data engineering best practices, architectures, and optimization strategies within the Databricks Community. Exchange insights and solutions with fellow data engineers.
cancel
Showing results for 
Search instead for 
Did you mean: 

Jobs API 2.1 OpenAPI specification seems broken.

j_al
New Contributor II

Jobs API 2.1 OpenAPI specification seems broken.

The swagger file seems to be invalid.

https://docs.databricks.com/_extras/api-refs/jobs-2.1-aws.yaml

10 REPLIES 10

Debayan
Databricks Employee
Databricks Employee

Hi, What do you mean by broken? Was there an issue running the API? If yes, any screenshot for reference?

please tag @Debayan​ with your next response which will notify me, Thank you!

j_al
New Contributor II

You can try to open above file in swagger editor to view the errors.

@Debayan Mukherjee​ 

Debayan
Databricks Employee
Databricks Employee

Hi, Could you please try with openapi: 3.0.3 and let us know whats the outcome?

Anonymous
Not applicable

Hi @Julius Almeida​ 

Hope all is well! Just wanted to check in if you were able to resolve your issue and would you be happy to share the solution or mark an answer as best? Else please let us know if you need more help. 

We'd love to hear from you.

Thanks!

JeffShutt_
New Contributor II

@Debayan Mukherjee​ , are you suggesting to revert the openapi version specified in https://docs.databricks.com/_extras/api-refs/jobs-2.1-aws.yaml from 3.1.0 to 3.0.3?

Debayan
Databricks Employee
Databricks Employee

Hi @Jeff Shutt​ , lets try to revert to 3.0.3 in a dev environment and try again?

JeffShutt_
New Contributor II

It's unclear to me what you are asking, so let me spell out what I am seeing so we are on the same page.

If you go to https://editor.swagger.io/ and input this document, https://docs.databricks.com/_extras/api-refs/jobs-2.1-aws.yaml, it tells you "Unable to render this definition"

If you go to https://editor-next.swagger.io/ and input the same document, it does seem to open there albeit with a few warnings.

If you go to https://apitools.dev/swagger-parser/online/ and input the same document, it does validate successfully as far as I can tell.

I am guessing this means that the old swagger editor doesn't support OpenAPI 3.1.0?

JeffShutt_
New Contributor II

@Debayan Mukherjee​ , now it appears that https://docs.databricks.com/_extras/api-refs/jobs-2.1-aws.yaml has been taken down and is replaced by the new API page. As a user of this API, are we not able to access this Open API spec for code generation anymore?

Debayan
Databricks Employee
Databricks Employee

Sorry for the delay, we can check internally on OpenAPI and confirm.

Also, https://docs.databricks.com/workflows/jobs/jobs-api-updates.html is the update.

tupshin_ct
New Contributor II

Any update on a replacement for the old openapi spec that was taken down?

Connect with Databricks Users in Your Area

Join a Regional User Group to connect with local Databricks users. Events will be happening in your city, and you won’t want to miss the chance to attend and share knowledge.

If there isn’t a group near you, start one and help create a community that brings people together.

Request a New Group