======================
Knowledge Pages API
======================
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**
.. contents::
:local:
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/{id}?&lang={lang}
- api/knowledge/page/{id}?lang={lang}
- api/knowledge/search/{search+terms}?lang={lang}
- api/knowledge/highlighted/{code}?lang={lang}
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 <https://gitlab.com/somitcoop/erp-research/odoo-helpdesk/-/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 <https://somit.coop>`_:
* José Robles <jose.robles@somit.coop>
* Álvaro García <alvaro.garcia@somit.coop>
* `Som Connexio SCCL <https://somconnexio.coop>`_:
* Gerard Funosas <gerard.funosas@somconnexio.coop>
Maintainers
~~~~~~~~~~~
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
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.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/somitcoop/erp-research/odoo-helpdesk",
"name": "odoo12-addon-knowledge-pages-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": null,
"author": "Som It Cooperatiu SCCL, Som Connexi\u00f3 SCCL, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": "https://files.pythonhosted.org/packages/c3/26/5ede7403d9e3e11d8610b34827950be21c0a8d902f72a7b8bed7b9ab1d69/odoo12-addon-knowledge_pages_api-12.0.1.1.0.tar.gz",
"platform": null,
"description": "======================\nKnowledge Pages API\n======================\n\nThis 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.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nConfiguration\n=============\n\nNo configuration needed for this module.\n\nUsage\n=====\n\nTo use this module, you can make requests to the following endpoints after installed:\n\n- api/knowledge/categories?category_initial={category_initial}&lang={lang}\n- api/knowledge/categories/{id}?&lang={lang}\n\n- api/knowledge/page/{id}?lang={lang}\n\n- api/knowledge/search/{search+terms}?lang={lang}\n- api/knowledge/highlighted/{code}?lang={lang}\n\nIt'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.\n\nKnown issues / Roadmap\n======================\n\nThere are no known issues for this module.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitLab Issues <https://gitlab.com/somitcoop/erp-research/odoo-helpdesk/-/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us smashing it by providing a detailed and welcomed feedback.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n~~~~~~~\n\n* SomIT SCCL\n* Som Connexio SCCL\n\nContributors\n~~~~~~~~~~~~\n\n* `SomIT SCCL <https://somit.coop>`_:\n\n * Jos\u00e9 Robles <jose.robles@somit.coop>\n * \u00c1lvaro Garc\u00eda <alvaro.garcia@somit.coop>\n\n* `Som Connexio SCCL <https://somconnexio.coop>`_:\n\n * Gerard Funosas <gerard.funosas@somconnexio.coop>\n\nMaintainers\n~~~~~~~~~~~\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n\n",
"bugtrack_url": null,
"license": "AGPL-3",
"summary": "REST API for Knowledge Pages",
"version": "12.0.1.1.0",
"project_urls": {
"Homepage": "https://gitlab.com/somitcoop/erp-research/odoo-helpdesk"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e64e3459be0c09afd58dcff172c86ddfda89c6d35a6ae192382c564b724144ce",
"md5": "b8992e2473f4232987305e4e985813df",
"sha256": "890cd2cd7d3133ffe7b038173e814695d2810f993756e402d8a0cc769650a84a"
},
"downloads": -1,
"filename": "odoo12_addon_knowledge_pages_api-12.0.1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8992e2473f4232987305e4e985813df",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 28557,
"upload_time": "2024-07-09T16:32:34",
"upload_time_iso_8601": "2024-07-09T16:32:34.820712Z",
"url": "https://files.pythonhosted.org/packages/e6/4e/3459be0c09afd58dcff172c86ddfda89c6d35a6ae192382c564b724144ce/odoo12_addon_knowledge_pages_api-12.0.1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c3265ede7403d9e3e11d8610b34827950be21c0a8d902f72a7b8bed7b9ab1d69",
"md5": "0b8f345aaeb4dbb9b8aa23ef6569df45",
"sha256": "053c2e0e03f56238656aeb54ce6ebd866dacf4736dca3720420ca1205130c1e0"
},
"downloads": -1,
"filename": "odoo12-addon-knowledge_pages_api-12.0.1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0b8f345aaeb4dbb9b8aa23ef6569df45",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 25919,
"upload_time": "2024-07-09T16:32:36",
"upload_time_iso_8601": "2024-07-09T16:32:36.477234Z",
"url": "https://files.pythonhosted.org/packages/c3/26/5ede7403d9e3e11d8610b34827950be21c0a8d902f72a7b8bed7b9ab1d69/odoo12-addon-knowledge_pages_api-12.0.1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-09 16:32:36",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "somitcoop",
"gitlab_project": "erp-research",
"lcname": "odoo12-addon-knowledge-pages-api"
}
JSON