Newer version of OpenAPI

Question, are you guys working on a newer version of the Swagger API? I’d like to use NSwagStudio to generate an Asterisk client but it seems Swagger 1.1 is used by Asterisk and this version is unsupported by NSwagStudio. Recent OpenAPI versions usually support the latest version: 3.

Currently people are writing the client themselves and an upgraded version of swagger would make this a lot easier because of the use of NSwagStudio.

Is there any information about a possible upgrade to OpenAPI version 3?

We don’t currently have plans to upgrade but we’re not all here this week because of the US holiday so let us discuss it next week when we’re all back.

1 Like

I had to create a volume in Docker and all I had to do was:

docker run --rm -v %CD%:/local swaggerapi/swagger-codegen-cli generate -i http://<ip>:8088/ari/api-docs/resources.json -l go -o /local/out/go

This creates a nice first draft of the OpenAPI v3.1 variant. Might help you guys too.

There’s more to it than that, and it is not a simple or small project. The documentation is used for code generation internally, as well we would need to have backwards compatibility. It also is used for the public documentation. It’s a huge undertaking that ripples out. There’s been two attempts to update in the past, both failed. Could we maintain the old and the new? Yes, but now we’re duplicating stuff as well and for what value. Someone brings this up maybe once every 2 years. In fact I’ve asked people in the past and still do occasionally about the importance or value of this, and the answer is always that people have no problem just doing the HTTP requests and other stuff themselves. I don’t see this being something we’d undertake anytime soon.

1 Like

Having to write proper code to implement only half of the API is such time consuming work. I think many man hours could be saved if a newer OpenAPI definition exists.

The generated JSON below still needs quite a bit of changes to be a quality OpenAPI definition. I am missing return types etc. Below is how far I got, but it’s not finished yet.

openapi_v3_0_1.txt (176.9 KB)

I do understand your point that others don’t mind.

(Change uploaded file)