Skip to content

Commit

Permalink
add description of new OCS endpoint
Browse files Browse the repository at this point in the history
for recommendations of files and folders

see nextcloud/recommendations#458

Signed-off-by: sualko <klaus@jsxc.org>
  • Loading branch information
sualko committed Jan 7, 2022
1 parent 085c935 commit c6d6732
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
1 change: 1 addition & 0 deletions developer_manual/client_apis/OCS/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ OCS API
ocs-share-api
ocs-sharee-api
ocs-status-api
ocs-recommendations-api
41 changes: 41 additions & 0 deletions developer_manual/client_apis/OCS/ocs-recommendations-api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
=======================
OCS Recommendations API
=======================

The OCS Recommendations API allows you to get a list of recommended files and folders with recent activity.

.. note:: This API requires the Recommendations app to be enabled.

The base URL for all calls to the share API is: *<nextcloud_base_url>/ocs/v2.php/apps/recommendations/api/v1/*

All calls to OCS endpoints require the ``OCS-APIRequest`` header to be set to ``true``.

.. warning:: This API is **experimental** and can change in the future without further notice!


Recommendations - Retrieval
---------------------------

Fetch user-controlled recommendations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* Method: ``GET``
* Endpoint: ``/recommendations``
* Response:
- Status code:
+ ``200 OK``
* Result:
- `enabled` (boolean) True if recommendations are enabled for user. False otherwise.
- `recommendations` (list, optional) List of recommended files and folders, if the user enabled recommendations.

Fetch user setting and recommendations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* Method: ``GET``
* Endpoint: ``/recommendations/always``
* Response:
- Status code:
+ ``200 OK``
* Result:
- `enabled` (boolean) True if recommendations are enabled for user. False otherwise.
- `recommendations` (list) List of recommended files and folders, independent of the users decision.

0 comments on commit c6d6732

Please sign in to comment.