An HTTP OPTIONS request return two important headers: "Allow" and "Link".

In order to discover the allowed HTTP methods for a given resource, we used some Rails routing introspection. At this point, now we need to store the Controller and Actions responsible for handling the calls, for instance:

req

OPTIONS /notes HTTP/1.1

res

Allow: GET, POST
Link: http://myrailsapp.net/optionsful/notes; type=text/html; rel=help

The Controller might be NotesController and the actions index responds to GET requests, and the create action handles a POST request.

GOAL: Using and extending Yard to document these 'entrypoints', using special tags and attribute oriented programming. Build up human readable document containing information about each service entrypoing.

SEE: http://github.com/visfleet/yard-rest-plugin