Skip to content
This repository has been archived by the owner on May 14, 2019. It is now read-only.

Latest commit

 

History

History
98 lines (65 loc) · 2.28 KB

README.rst

File metadata and controls

98 lines (65 loc) · 2.28 KB
License: LGPL-3

REST API / Open API (Swagger)

Set up REST API and export Open API (Swagger) specification file for integration with whatever you need.

This module implements a /api/v1/ route tree.

Authentication

  • Server wide "break glass" through a salt in the config file
  • Database inference: Database name encoded and appended to the token
  • User authentication through the actual token

As a workaround for multi-db instances, system uses Basic Authentication with db_name:token credentials, where token is a new field in res.users model.

Customization

TODO

The module already includes configuration for the following models:

  • report
  • sale.order
  • sale.order.line
  • account.invoice
  • account.invoice.line
  • res.partner
  • product.template

TODO: Redefine ir.model to load default configuration on load

The module allows to configure

  • available models
  • available operations per model (CRUD)
  • enable/disable private methods through API
  • method whitelist
  • specification for the following operations
    • For reading ONE:
      • return field sets
    • For reading MULTI:
      • return field sets

Check Usage instruction for details.

Credits

Contributors

Sponsors

Maintainers

Further information

Usage instructions: doc/index.rst

Changelog: doc/changelog.rst