Skip to main content

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

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

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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.

Metadata

Release files for odoo12-addon-knowledge-pages-api 12.0.1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for odoo12-addon-knowledge-pages-api 12.0.1.2.1
File Size Uploaded Provenance
odoo12-addon-knowledge_pages_api-12.0.1.2.1.tar.gz 28.5 kB Without provenance Details

Release files / odoo12-addon-knowledge_pages_api-12.0.1.2.1.tar.gz

Download URL odoo12-addon-knowledge_pages_api-12.0.1.2.1.tar.gz
Size 28.5 kB
Tags Source
SHA-256 checksum
How to use checksums
82ec2ac19322716a858a6a37b60a023c5c3dcd5ae89d3e0fc9b23ecab61481f6
BLAKE2b-256 checksum
How to use checksums
cc38f71f9700f8cefaa8763b1d5fb50713834ba9cbcd9845a7c3cbb7a1e8bf24
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.8.2

Security for odoo12-addon-knowledge-pages-api 12.0.1.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page