- Issues pertaining to the documentation itself can be opened in this repository.
- Issues pertaining to code behind the API are in the core repository, labeled as TaxonWorks issues.
Contributing follows standard Git practices.
Please follow the CODE_OF_CONDUCT.md.
Development happens on development, or lands there as a precursor to merging in main.
API documentation is decoupled from code generation, i.e. we use RAML strictly to build out the HTML documentation at present.
Most routes will correspond to filter code in lib/queries/, i.e. we expose /<model>.json endpoints via a new parallel route.
Many existing patterns/example exist for TaxonNames (i.e. see controller, routes, etc.).
Add the controller action to the corresponding controllers.
Simply duplicate the index method that hits the Filter model.
You can also duplicate the parameter filtering method (e.g. filter_params) to limit params to expose.
Document the permitted params, and route in the RAML.