Event naming conventions

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Mon, Oct 21, 2013 at 7:06 PM, Paul Belanger <paul.belanger at polybeacon.com
> wrote:

> On Mon, Oct 21, 2013 at 10:56 AM, David M. Lee <dlee at digium.com> wrote:
> >
> > On Oct 21, 2013, at 8:09 AM, Alistair Cunningham <
> acunningham at integrics.com> wrote:
> >
> >> When I now check this page:
> >>
> >> https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+REST+Data+Models
> >>
> >> I see no mention of Answer or Hangup. Have these already been removed,
> or am I looking on the wrong page?
> >
> > That's the right page.
> >
> >> I must confess that I'm not quite sure where to look on the Wiki for
> information about the websocket events. Is the "Data Models" page the same
> as the "Events" page? Matt showed me the correct place, but I foolishly
> failed to bookmark it. Apologies for the confusion?
> >
> > No worries? it's new for everyone.
> >
> > The "_ REST API" pages all of the basic structure. It leads off with a
> summary table, with HTTP method, URI path, return model (what you can
> expect as a response to the call) and a short summary of the operation.
> >
> > The "Path" column links further down the page where you can find more
> details about the operation (longer description, operation parameters,
> etc.).
> >
> > The "Return Model" column links into the "REST Data Models" page, where
> the return model schema is documented.
> >
> > The /events WebSocket is a bit wonky, because it can return many
> different types of messages.
> >
> > The way the model is structured, the 'Message' return model is actually
> a base-type for all of the events that could come over the /events
> WebSocket. If you click the 'Message' link, it will take you to the docs
> for that type, where all of the subtypes for Message are listed. That doc
> also tells you that the 'type' field in 'Message' is used as the
> discriminator, so you can tell what type of event you actually received.
> >
> > While this all seems very clear to me, I'm the one who wrote it :-D
> >
> > Suggestions for clarifying the wiki docs are gladly welcomed.
> >
> So, I guess the first question is do we want to keep the AMI / ARI
> naming of events is _somewhat_ similar?  AMI tends to be now,
> DTMFBegin and ARI the past, PlaybackStarted.
>
>
I'm sorry I even mentioned the AMI... I'd much rather keep it past tense...


> --
> Paul Belanger | PolyBeacon, Inc.
> Jabber: paul.belanger at polybeacon.com | IRC: pabelanger (Freenode)
> Github: https://github.com/pabelanger | Twitter:
> https://twitter.com/pabelanger
>
> _______________________________________________
> asterisk-app-dev mailing list
> asterisk-app-dev at lists.digium.com
> http://lists.digium.com/cgi-bin/mailman/listinfo/asterisk-app-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-app-dev/attachments/20131021/08c5a95d/attachment.html>


[Index of Archives]     [Asterisk SS7]     [Asterisk Announcements]     [Asterisk Users]     [PJ SIP]     [Linux ARM Kernel]     [Linux ARM]     [Linux Omap]     [Fedora ARM]     [IETF Annouce]     [Security]     [Bugtraq]     [Linux]     [Linux OMAP]     [Linux MIPS]     [ECOS]     [Linux API]

  Powered by Linux