Merge pull request #3011 from jmchilton/api_docs

Update some old information in API guideline docs.
This commit is contained in:
Martin Cech
2016-10-05 22:15:44 -04:00
committed by GitHub
+3 -5
View File
@@ -8,7 +8,7 @@ these guidelines - but developers contributing to the Galaxy API SHOULD follow
these guidelines.
- API functionality should include docstring documentation for consumption
by readthedocs.org.
at docs.galaxyproject.org.
- Developers should familiarize themselves with the HTTP status code definitions
http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html. The API responses
should properly set the status code according to the result - in particular
@@ -50,12 +50,10 @@ consider them when modifying the API.
that into Mixins (http://en.wikipedia.org/wiki/Composition_over_inheritance)
or into Managers (:doc:`galaxy.managers`).
- API additions are more permanent changes to Galaxy than many other potential
changes and so a second opinion on API changes should be sought. (Consider a
pull request!)
changes and so a second opinion on API changes should be sought.
- New API functionality should include functional tests. These functional
tests should be implemented in Python and placed in
`test/functional/api`. (Once such a framework is in place - it is not
right now).
`test/functional/api`.
- Changes to reflect modifications to the API should be pushed upstream to
the BioBlend project if possible.