You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

69 lines
2.3 KiB

  1. ================
  2. Easy My Coop API
  3. ================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-coopiteasy%2Fvertical--cooperative-lightgray.png?logo=github
  15. :target: https://github.com/coopiteasy/vertical-cooperative/tree/12.0/easy_my_coop_api
  16. :alt: coopiteasy/vertical-cooperative
  17. |badge1| |badge2| |badge3|
  18. Open Easy My Coop to the world: RESTful API.
  19. **Table of contents**
  20. .. contents::
  21. :local:
  22. Known issues / Roadmap
  23. ======================
  24. The API should generate and use an external id for records instead
  25. of odoo's generated id. It would make importing and export data as
  26. well as migrating across versions easier.
  27. One way would be to use uuid but the default BaseRESTController
  28. routes would need to be rewritten: they only take integer as ids.
  29. Another way is to define a sequence per model.
  30. Bug Tracker
  31. ===========
  32. Bugs are tracked on `GitHub Issues <https://github.com/coopiteasy/vertical-cooperative/issues>`_.
  33. In case of trouble, please check there if your issue has already been reported.
  34. If you spotted it first, help us smashing it by providing a detailed and welcomed
  35. `feedback <https://github.com/coopiteasy/vertical-cooperative/issues/new?body=module:%20easy_my_coop_api%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  36. Do not contact contributors directly about support or help with technical issues.
  37. Credits
  38. =======
  39. Authors
  40. ~~~~~~~
  41. * Coop IT Easy SCRLfs
  42. Contributors
  43. ~~~~~~~~~~~~
  44. * Coop IT Easy SCRLfs
  45. * Robin Keunen <robin@coopiteasy.be>
  46. Maintainers
  47. ~~~~~~~~~~~
  48. This module is part of the `coopiteasy/vertical-cooperative <https://github.com/coopiteasy/vertical-cooperative/tree/12.0/easy_my_coop_api>`_ project on GitHub.
  49. You are welcome to contribute.