#1 ✓resolved
Marco Antonio Gonzalez Junior

New feature: GET rel help support

Reported by Marco Antonio Gonzalez Junior | July 20th, 2010 @ 04:01 PM | in 0.2.0

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:


OPTIONS /notes HTTP/1.1


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

Comments and changes to this ticket

Please Sign in or create a free account to add a new ticket.

With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.

New-ticket Create new ticket

Create your profile

Help contribute to this project by taking a few moments to create your personal profile. Create your profile ยป

Provide dynamic information about resources via the OPTIONS' HTTP method on a RESTful design over the Ruby on Rails framework.

Shared Ticket Bins

People watching this ticket