1. Georg Brandl
  2. sphinx-contrib
Issue #31 new

httpdomain: primary directive should be a resource, not a method

Éric Araujo
created an issue

The http domain is a great idea, thanks for writing it. I find it strange that the directives are HTTP methods; my expectation would be an http:resource directive to describe what a resource is, with nested http:{method} directives to document allowed methods. An example: {{{ .. http:resource:: /users

Collection resource for the people who have installed the game.

.. http:get::

  Get a list of all users.  Can return JSON or HTML according to the client :mailheader:`Accept` header.  etc.

  :query limit: If given, restrict the results to the number given.

.. http:post::

  Create a new user.  etc.

}}}

What do you think?

Comments (8)

  1. Log in to comment