diff options
Diffstat (limited to 'core/Controller/ReferenceApiController.php')
| -rw-r--r-- | core/Controller/ReferenceApiController.php | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/core/Controller/ReferenceApiController.php b/core/Controller/ReferenceApiController.php index 3d144c8559f..384011f8020 100644 --- a/core/Controller/ReferenceApiController.php +++ b/core/Controller/ReferenceApiController.php @@ -56,6 +56,8 @@ class ReferenceApiController extends \OCP\AppFramework\OCSController { * @param bool $resolve Resolve the references * @param int $limit Maximum amount of references to extract * @return DataResponse<Http::STATUS_OK, array{references: array<string, CoreReference|null>}, array{}> + * + * 200: References returned */ public function extract(string $text, bool $resolve = false, int $limit = 1): DataResponse { $references = $this->referenceManager->extractReferences($text); @@ -82,6 +84,8 @@ class ReferenceApiController extends \OCP\AppFramework\OCSController { * * @param string $reference Reference to resolve * @return DataResponse<Http::STATUS_OK, array{references: array<string, ?CoreReference>}, array{}> + * + * 200: Reference returned */ public function resolveOne(string $reference): DataResponse { /** @var ?CoreReference $resolvedReference */ @@ -100,6 +104,8 @@ class ReferenceApiController extends \OCP\AppFramework\OCSController { * @param string[] $references References to resolve * @param int $limit Maximum amount of references to resolve * @return DataResponse<Http::STATUS_OK, array{references: array<string, CoreReference|null>}, array{}> + * + * 200: References returned */ public function resolve(array $references, int $limit = 1): DataResponse { $result = []; @@ -123,6 +129,8 @@ class ReferenceApiController extends \OCP\AppFramework\OCSController { * Get the providers * * @return DataResponse<Http::STATUS_OK, CoreReferenceProvider[], array{}> + * + * 200: Providers returned */ public function getProvidersInfo(): DataResponse { $providers = $this->referenceManager->getDiscoverableProviders(); @@ -140,6 +148,8 @@ class ReferenceApiController extends \OCP\AppFramework\OCSController { * @param string $providerId ID of the provider * @param int|null $timestamp Timestamp of the last usage * @return DataResponse<Http::STATUS_OK, array{success: bool}, array{}> + * + * 200: Provider touched */ public function touchProvider(string $providerId, ?int $timestamp = null): DataResponse { if ($this->userId !== null) { |