[asterisk-bugs] [JIRA] (ASTERISK-24300) API docs don't conform to stated Swagger version

[Matt Jordan (JIRA)]

    [ https://issues.asterisk.org/jira/browse/ASTERISK-24300?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=223022#comment-223022 ] 

Matt Jordan commented on ASTERISK-24300:
----------------------------------------

FYI, this is *not* a minor version bump. I'm not sure what lunatic versioning scheme the Swagger guys are following, but if anything is a case study on "what not to do" when doing a minor version bump, this is it:

https://github.com/wordnik/swagger-spec/wiki/1.2-transition

I'm scared to even look at the 1.2 => 2.0 transition.

While I do think we will need to jump to 1.2, there's no way to get there from here without potentially breaking client libraries that rely on Swagger. I'm inclined to punt this to Asterisk 14, although I'd hate to do that and then have wordnik decide to totally stop supporting Swagger 1.1.

> API docs don't conform to stated Swagger version
> ------------------------------------------------
>
>                 Key: ASTERISK-24300
>                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-24300
>             Project: Asterisk
>          Issue Type: Bug
>      Security Level: None
>          Components: Documentation
>    Affects Versions: SVN, 12.5.1, 13.0.0-beta1
>            Reporter: Bradley Watkins
>
> For at least events.json, the stated Swagger version (in that case 1.2) is not what's actually in use.  It appears, based on some historical asterisk-dev mailing list posts, that an in-progress version of 1.2 was used.  However, now that 1.2 has been finalized I think it's important to update the models and code generation tools to that spec.
> As it stands, any tools built to work with the 1.2 standard will not function correctly against Asterisk's api docs.



--
This message was sent by Atlassian JIRA
(v6.2#6252)