farmOS API Discussion 2019-03-20

farmOS-api-20190320.md

farmOS API Discussion 2019-03-20

Michael Stenta Jamie Gaehring Paul Weidner

Library links:

• farmOS.js
• farmOS.py
• farmOS.php

Questions:

• What does farmOS.js have that farmOS.py/php don't?
  • Ability to send() records.
  • Ability to delete() records.
  • Specific methods for assets and logs.
  • farm.info() (/farm.json)
• What do neither have?
  • farm.user
• Should get() return ALL records by default, or pages of records by default?
  • Yes (farmOS.js already does this)
  • Should have the OPTION to return individual pages
    • There are cases where you will want to process in batches, eg: in PHP or Flask during a page request or API call (don't want to hold up the response)

API docs

• What should we use? Slate? Mkdocs? Sphinx?
  • We want:
    • Markdown
    • Versioning
    • Examples in different languages
    • ...
• It can live at api.farmos.org, but should be in the same farmOS.org repo (alongside Mkdocs).
• Mike can provide hosting for if the limitation of GitHub Pages (one site per repo)
• Maybe we can move to Netlify later.

Next steps

1. Paul: add methods/classes to farmOS.py to bring it into sync with farmOS.js.
2. Paul: automated testing of farmOS.py
   • Think about stadardized tests across libraries
   • pytest? pytest in Github?
3. Paul: Add user support.
4. Jamie: Add user support.