Does RAML support Asynchronous Responses


#1

Hi,

Does RAML support documenting Asynchronous Responses?
http://docs.oracle.com/javaee/7/api/javax/ws/rs/container/AsyncResponse.html

My API returns a HTTP 202 Accepted Response and then sometime in the future some other JSON AsyncResponse.
How can this be documented in RAML?


#2

RAML is just the spec to describe the API. You can provide a response of 202 and describe it, including with a schema and example (although 202 typically returns no body). As far as I know, that is how you would do this. Document the async response that returns at some time later in the Description element of the 202 Response.