add restful API #458
add restful API #458
Conversation
fix #457 Signed-off-by: sualko <[email protected]>
| use OCP\IRequest; | ||
| use OCP\IUserManager; | ||
|
|
||
| class RecommendationApiController extends ApiController { |
There was a problem hiding this comment.
I think this should be using OCSController instead: https://docs.nextcloud.com/server/latest/developer_manual/basics/controllers.html#ocs
There was a problem hiding this comment.
The first sentence in the info box is saying: "This is purely for compatibility reasons. If you are planning to offer an external API, go for a REST APIs instead.".
There was a problem hiding this comment.
hmm yeah, not completely sure. I remember seeing some new stuff using OCSController. It's probably better to confirm with someone involved in Nextcloud since a longer time :)
@ChristophWurst do you know what is the recommended way?
There was a problem hiding this comment.
I'm not very experienced with external API. @nickvergessen is the expert here :)
There was a problem hiding this comment.
Definitely should be an OCS controller, so all our clients can hook it up and use it in the future
There was a problem hiding this comment.
Well then what is this API needed for?
There was a problem hiding this comment.
As per #457 they want to use it in the Outlook plugin, so yeah that is exactly why we have OCS apis and it should be used in this case.
There was a problem hiding this comment.
I transformed it to an OCS controller, but I don't know who will maintain it in the future 😉
There was a problem hiding this comment.
@sualko please document the API at https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/index.html.
We'll allow the API but there are no guarantees for future compatibility, hence please flag as experimental.
There was a problem hiding this comment.
Also @sualko can you ping us or @ChristophWurst respectively when this is fully integrated and "stable". Reason is we would then merge it when the docs are in but wouldn't publish a new release yet, so in case you need to do some more changes during integration that could still be done and there wouldn't be any scenario that would require migration logic for app upgrades, since this wasn't published yet, which would safe everybody some time.
If this is already finished and works fine from your perspective, please let us know.
Signed-off-by: sualko <[email protected]>
for recommendations of files and folders see nextcloud/recommendations#458 Signed-off-by: sualko <[email protected]>
|
@leonvandebroek can you please test this and report if it's working for you? @ChristophWurst documentation is prepared (nextcloud/documentation#7877) and I submitted a pr to fix a bug which prevents the xml serialization (nextcloud/server#30417). |
for recommendations of files and folders see nextcloud/recommendations#458 Signed-off-by: sualko <[email protected]>
|
|
||
| /** @var IConfig */ | ||
| private $config; | ||
|
|
||
| /** @var IUserManager */ | ||
| private $userManager; | ||
|
|
||
| /** @var RecommendationService */ | ||
| private $service; |
There was a problem hiding this comment.
| /** @var IConfig */ | |
| private $config; | |
| /** @var IUserManager */ | |
| private $userManager; | |
| /** @var RecommendationService */ | |
| private $service; | |
| private IConfig $config; | |
| private IUserManager $userManager; | |
| private RecommendationService $service; | |
| private ?string $userId; |
| public function __construct($appName, IRequest $request, IConfig $config, | ||
| IUserManager $userManager, | ||
| RecommendationService $service, $userId) { |
There was a problem hiding this comment.
| public function __construct($appName, IRequest $request, IConfig $config, | |
| IUserManager $userManager, | |
| RecommendationService $service, $userId) { | |
| public function __construct(string $appName, IRequest $request, IConfig $config, | |
| IUserManager $userManager, | |
| RecommendationService $service, ?string $userId) { |
| $this->userId = $userId; | ||
| } | ||
|
|
||
| /** |
There was a problem hiding this comment.
| /** | |
| /** | |
| * Get the recommendations for the user if the recommendations are enabled for the user |
| ); | ||
| } | ||
|
|
||
| /** |
There was a problem hiding this comment.
| /** | |
| /** | |
| * Get the recommendations for the user even if the recommendations are disablde for the user |
|
Could this be rebased @sualko ? |
It's basically the same as the existing endpoint, but with a few enhancements (which could also be integrated with the existing controller):
cc @leonvandebroek