odoo12-addon-knowledge-pages-api 12.0.1.2.1

REST API for Knowledge Pages

This module adds a REST API for knowledge pages. It allows you to retrieve categories and their child pages, as well as the details of a specific page.

Table of contents

• Configuration

• Usage

• Known issues / Roadmap

• Bug Tracker

• Credits

  • Authors

  • Contributors

  • Maintainers

Configuration

No configuration needed for this module.

Usage

To use this module, you can make requests to the following endpoints after installed:

• api/knowledge/categories?category_initial={category_initial}&lang={lang}

• api/knowledge/categories/{api_reference}?&lang={lang}

• api/knowledge/page/{api_reference}?lang={lang}

• api/knowledge/page/{tag}?lang={lang}

• api/knowledge/search/{search+terms}?lang={lang}

• api/knowledge/highlighted/{code}?lang={lang}

For the record, category_initial and api_reference are both the API unique identification string assigned ot the page or category.

It’s worth mentioning that the {search+terms} param is url encoded text so for special characters (other than spaces which translates to the plus sign) have to be encoded in the url.

Known issues / Roadmap

There are no known issues for this module.

Bug Tracker

Bugs are tracked on GitLab Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

• SomIT SCCL

• Som Connexio SCCL

Contributors

• SomIT SCCL:

  • José Robles <[e-mail]>

  • Álvaro García <[e-mail]>

  • Juan Manuel Regalado <[e-mail]>

• Som Connexio SCCL:

  • Gerard Funosas <[e-mail]>

Maintainers

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.