Skip to content
Snippets Groups Projects
  • David M. Lee's avatar
    c9a3d456
    Update events to use Swagger 1.3 subtyping, and related aftermath · c9a3d456
    David M. Lee authored
    This patch started with the simple idea of changing the /events data
    model to be more sane. The original model would send out events like:
    
        { "stasis_start": { "args": [], "channel": { ... } } }
    
    The event discriminator was the field name instead of being a value in
    the object, due to limitations in how Swagger 1.1 could model objects.
    While technically sufficient in communicating event information, it was
    really difficult to deal with in terms of client side JSON handling.
    
    This patch takes advantage of a proposed extension[1] to Swagger which
    allows type variance through the use of a discriminator field. This had
    a domino effect that made this a surprisingly large patch.
    
     [1]: https://groups.google.com/d/msg/wordnik-api/EC3rGajE0os/ey_5dBI_jWcJ
    
    In changing the models, I also had to change the swagger_model.py
    processor so it can handle the type discriminator and subtyping. I took
    that a big step forward, and using that information to generate an
    ari_model module, which can validate a JSON object against the Swagger
    model.
    
    The REST and WebSocket generators were changed to take advantage of the
    validators. If compiled with AST_DEVMODE enabled, JSON objects that
    don't match their corresponding models will not be sent out. For REST
    API calls, a 500 Internal Server response is sent. For WebSockets, the
    invalid JSON message is replaced with an error message.
    
    Since this took over about half of the job of the existing JSON
    generators, and the .to_json virtual function on messages took over the
    other half, I reluctantly removed the generators.
    
    The validators turned up all sorts of errors and inconsistencies in our
    data models, and the code. These were cleaned up, with checks in the
    code generator avoid some of the consistency problems in the future.
    
     * The model for a channel snapshot was trimmed down to match the
       information sent via AMI. Many of the field being sent were not
       useful in the general case.
     * The model for a bridge snapshot was updated to be more consistent
       with the other ARI models.
    
    Another impact of introducing subtyping was that the swagger-codegen
    documentation generator was insufficient (at least until it catches up
    with Swagger 1.2). I wanted it to be easier to generate docs for the API
    anyways, so I ported the wiki pages to use the Asterisk Swagger
    generator. In the process, I was able to clean up many of the model
    links, which would occasionally give inconsistent results on the wiki. I
    also added error responses to the wiki docs, making the wiki
    documentation more complete.
    
    Finally, since Stasis-HTTP will now be named Asterisk REST Interface
    (ARI), any new functions and files I created carry the ari_ prefix. I
    changed a few stasis_http references to ari where it was non-intrusive
    and made sense.
    
    (closes issue ASTERISK-21885)
    Review: https://reviewboard.asterisk.org/r/2639/
    
    
    
    git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@393529 65c4cc65-6c06-0410-ace0-fbb531ad65f3
    c9a3d456
    History
    Update events to use Swagger 1.3 subtyping, and related aftermath
    David M. Lee authored
    This patch started with the simple idea of changing the /events data
    model to be more sane. The original model would send out events like:
    
        { "stasis_start": { "args": [], "channel": { ... } } }
    
    The event discriminator was the field name instead of being a value in
    the object, due to limitations in how Swagger 1.1 could model objects.
    While technically sufficient in communicating event information, it was
    really difficult to deal with in terms of client side JSON handling.
    
    This patch takes advantage of a proposed extension[1] to Swagger which
    allows type variance through the use of a discriminator field. This had
    a domino effect that made this a surprisingly large patch.
    
     [1]: https://groups.google.com/d/msg/wordnik-api/EC3rGajE0os/ey_5dBI_jWcJ
    
    In changing the models, I also had to change the swagger_model.py
    processor so it can handle the type discriminator and subtyping. I took
    that a big step forward, and using that information to generate an
    ari_model module, which can validate a JSON object against the Swagger
    model.
    
    The REST and WebSocket generators were changed to take advantage of the
    validators. If compiled with AST_DEVMODE enabled, JSON objects that
    don't match their corresponding models will not be sent out. For REST
    API calls, a 500 Internal Server response is sent. For WebSockets, the
    invalid JSON message is replaced with an error message.
    
    Since this took over about half of the job of the existing JSON
    generators, and the .to_json virtual function on messages took over the
    other half, I reluctantly removed the generators.
    
    The validators turned up all sorts of errors and inconsistencies in our
    data models, and the code. These were cleaned up, with checks in the
    code generator avoid some of the consistency problems in the future.
    
     * The model for a channel snapshot was trimmed down to match the
       information sent via AMI. Many of the field being sent were not
       useful in the general case.
     * The model for a bridge snapshot was updated to be more consistent
       with the other ARI models.
    
    Another impact of introducing subtyping was that the swagger-codegen
    documentation generator was insufficient (at least until it catches up
    with Swagger 1.2). I wanted it to be easier to generate docs for the API
    anyways, so I ported the wiki pages to use the Asterisk Swagger
    generator. In the process, I was able to clean up many of the model
    links, which would occasionally give inconsistent results on the wiki. I
    also added error responses to the wiki docs, making the wiki
    documentation more complete.
    
    Finally, since Stasis-HTTP will now be named Asterisk REST Interface
    (ARI), any new functions and files I created carry the ari_ prefix. I
    changed a few stasis_http references to ari where it was non-intrusive
    and made sense.
    
    (closes issue ASTERISK-21885)
    Review: https://reviewboard.asterisk.org/r/2639/
    
    
    
    git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@393529 65c4cc65-6c06-0410-ace0-fbb531ad65f3