search

apiaryio / api-blueprint

API Blueprint
https://apiblueprint.org
MIT License
8.64k stars 2.14k forks source link

Webhook notification handling #323

Open inigo-montoya opened 8 years ago

inigo-montoya commented 8 years ago

Would like to see an ability to document webhooks and the callback notification events details

zdne commented 8 years ago

Hey @inigo-montoyahh , would you mind to elaborate a bit more. Maybe even with a pseudo-syntax proposal?

ghost commented 8 years ago

@zdne I think one change could relieve a lot of documentation frustration and that is a custom URL endpoint. Right now we can't change from the specified HOST at the beginning of a blueprint spec. Maybe something like the following signifying ASYNC and allowing a protocol, host, etc to be specified for the sole method?

### Do some webhook thing [ASYNC POST http://www.yourdomain.com/serser]

+ Request (application/json)
    + Attributes
        + `bananas` : `bananas` (string, required)
ghost commented 8 years ago

This could be expanded upon even further to allow more than http:// / https:// to be valid such as ws://, wss://, etc.

pksunkara commented 7 years ago

@btskyy That sounds like a good idea.

zdne commented 7 years ago

Note: See #289 for different protocol's support.