[asterisk-dev] OpenAPI 3.1 API description for ARI

[Nicolas HEDGER]

Understood,

I’ve identified at least the following cases where the current definition is used.

- https://github.com/asterisk/asterisk/blob/master/rest-api-templates/swagger_model.py <https://github.com/asterisk/asterisk/blob/master/rest-api-templates/swagger_model.py> not entirely sure what this does
- https://github.com/asterisk/asterisk/blob/master/tests/test_ari.c <https://github.com/asterisk/asterisk/blob/master/tests/test_ari.c>, which runs ARI’s tests, I assume
- https://github.com/asterisk/asterisk/blob/master/rest-api-templates/make_ari_stubs.py <https://github.com/asterisk/asterisk/blob/master/rest-api-templates/make_ari_stubs.py>, to render the wiki documentation

I’d be grateful for any help identifying any additional references, if any.

Regarding backwards compatibility, I was not planning on changing anything in the API if that’s what you mean, only to update the definition file and related tests/docs.

Nicolas HEDGER



> On 24 Jun 2022, at 19:18, Joshua C. Colp <jcolp at sangoma.com> wrote:
> 
> On Fri, Jun 24, 2022 at 2:11 PM Nicolas HEDGER <nicolas at hedger.ch <mailto:nicolas at hedger.ch>> wrote:
> Hi,
> 
> I noticed that ARI’s API description uses Swagger 1.1, which is at least a few years old.
> 
> I was wondering if there’d be interest in an OpenAPI 3.1 version, in which case I’d be willing to contribute.
> 
> It would probably allow using more current tools to generate API clients.
> 
> I'm sure someone would like it. The issue though is not just writing the definitions. The existing JSON files are actually used to produce generated base code for things so that also has to change. There would also need to be backwards compatibility present, to be allowed in older versions.
> 
> -- 
> Joshua C. Colp
> Asterisk Technical Lead
> Sangoma Technologies
> Check us out at www.sangoma.com <http://www.sangoma.com/> and www.asterisk.org <http://www.asterisk.org/>
> -- 
> _____________________________________________________________________
> -- Bandwidth and Colocation Provided by http://www.api-digital.com --
> 
> asterisk-dev mailing list
> To UNSUBSCRIBE or update options visit:
>   http://lists.digium.com/mailman/listinfo/asterisk-dev

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20220624/c33ca516/attachment.html>