Inheritance of methods

[Anne Gentle]

Opened by russell on 2015-09-27 03:02:14+00:00 at https://github.com/russell/fairy-slipper/issues/28

------------------------------------------------------------

I think that we should define a new http method type called abstract, It's purpose will be to define the generic values of return codes and headers/parameters/tags that are relevant to all calls that inherit from this abstract implementation.

.. http:_abstract_:: /

   :statuscode 200: Success

Each real method definition should be able to inherit from a single abstract method. The abstract methods should be able to inherit from each other and the order they are loaded will determine which ones take precedence.

.. http:get:: /
   :inherits: /

   List versions

The resulting method from this contrived example should be equivalent to

.. http:get:: /

   List versions
   :statuscode 200: Success

This should allow for a massive reduction as any common elements like, headers or path arguments, or common return status codes can be easily defined and will be expressed from a single location. Instead of duplicated throughout the documentation.

Tags: RST

[Andreas Jaeger (jaegerandi)]

we do not use swagger anymore