diff options
author | Julius Härtl <jus@bitgrid.net> | 2024-02-26 16:30:16 +0100 |
---|---|---|
committer | Julius Härtl <jus@bitgrid.net> | 2024-03-05 08:13:58 +0100 |
commit | c7813bfdaf09626dfed13c63b28a3919018d4403 (patch) | |
tree | 07d8c13bd7b3628e88f606bbf56db40bfc96e227 /core | |
parent | 2c9761c73ad1ea51f13103819637fbd315806761 (diff) | |
download | nextcloud-server-c7813bfdaf09626dfed13c63b28a3919018d4403.tar.gz nextcloud-server-c7813bfdaf09626dfed13c63b28a3919018d4403.zip |
feat: Implement team provider api
Signed-off-by: Julius Härtl <jus@bitgrid.net>
Diffstat (limited to 'core')
-rw-r--r-- | core/Controller/TeamsApiController.php | 97 | ||||
-rw-r--r-- | core/ResponseDefinitions.php | 15 | ||||
-rw-r--r-- | core/openapi.json | 225 |
3 files changed, 337 insertions, 0 deletions
diff --git a/core/Controller/TeamsApiController.php b/core/Controller/TeamsApiController.php new file mode 100644 index 00000000000..f937bcb847c --- /dev/null +++ b/core/Controller/TeamsApiController.php @@ -0,0 +1,97 @@ +<?php + +declare(strict_types=1); +/** + * @copyright Copyright (c) 2024 Julius Härtl <jus@bitgrid.net> + * + * @author Julius Härtl <jus@bitgrid.net> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +namespace OC\Core\Controller; + +use OCA\Core\ResponseDefinitions; +use OCP\AppFramework\Http; +use OCP\AppFramework\Http\Attribute\ApiRoute; +use OCP\AppFramework\Http\Attribute\NoAdminRequired; +use OCP\AppFramework\Http\DataResponse; +use OCP\IRequest; +use OCP\Teams\ITeamManager; +use OCP\Teams\Team; + +/** + * @psalm-import-type CoreTeamResource from ResponseDefinitions + * @psalm-import-type CoreTeam from ResponseDefinitions + * @property $userId string + */ +class TeamsApiController extends \OCP\AppFramework\OCSController { + public function __construct( + string $appName, + IRequest $request, + private ITeamManager $teamManager, + private ?string $userId, + ) { + parent::__construct($appName, $request); + } + + /** + * Get all resources of a team + * + * @param string $teamId Unique id of the team + * @return DataResponse<Http::STATUS_OK, array{resources: CoreTeamResource[]}, array{}> + * + * 200: Resources returned + */ + #[NoAdminRequired] + #[ApiRoute(verb: 'GET', url: '/{teamId}/resources', root: '/teams')] + public function resolveOne(string $teamId): DataResponse { + /** + * @var CoreTeamResource[] $resolvedResources + * @psalm-suppress PossiblyNullArgument The route is limited to logged-in users + */ + $resolvedResources = $this->teamManager->getSharedWith($teamId, $this->userId); + + return new DataResponse(['resources' => $resolvedResources]); + } + + /** + * Get all teams of a resource + * + * @param string $providerId Identifier of the provider (e.g. deck, talk, collectives) + * @param string $resourceId Unique id of the resource to list teams for (e.g. deck board id) + * @return DataResponse<Http::STATUS_OK, array{teams: CoreTeam[]}, array{}> + * + * 200: Teams returned + */ + #[NoAdminRequired] + #[ApiRoute(verb: 'GET', url: '/resources/{providerId}/{resourceId}', root: '/teams')] + public function listTeams(string $providerId, string $resourceId): DataResponse { + /** @psalm-suppress PossiblyNullArgument The route is limited to logged-in users */ + $teams = $this->teamManager->getTeamsForResource($providerId, $resourceId, $this->userId); + /** @var CoreTeam[] $teams */ + $teams = array_map(function (Team $team) { + $response = $team->jsonSerialize(); + /** @psalm-suppress PossiblyNullArgument The route is limited to logged in users */ + $response['resources'] = $this->teamManager->getSharedWith($team->getId(), $this->userId); + return $response; + }, $teams); + + return new DataResponse([ + 'teams' => $teams, + ]); + } +} diff --git a/core/ResponseDefinitions.php b/core/ResponseDefinitions.php index b8f73bcdcda..4a79c3ad3ec 100644 --- a/core/ResponseDefinitions.php +++ b/core/ResponseDefinitions.php @@ -161,6 +161,21 @@ namespace OCA\Core; * numberOfImages: int, * completionExpectedAt: ?int, * } + * + * @psalm-type CoreTeam = array{ + * id: string, + * name: string, + * icon: string, + * } + * + * @psalm-type CoreTeamResource = array{ + * id: int, + * label: string, + * url: string, + * iconSvg: ?string, + * iconURL: ?string, + * iconEmoji: ?string, + * } */ class ResponseDefinitions { } diff --git a/core/openapi.json b/core/openapi.json index 2c6b5f28ef2..8bb7beca406 100644 --- a/core/openapi.json +++ b/core/openapi.json @@ -406,6 +406,60 @@ } } }, + "Team": { + "type": "object", + "required": [ + "id", + "name", + "icon" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "icon": { + "type": "string" + } + } + }, + "TeamResource": { + "type": "object", + "required": [ + "id", + "label", + "url", + "iconSvg", + "iconURL", + "iconEmoji" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "label": { + "type": "string" + }, + "url": { + "type": "string" + }, + "iconSvg": { + "type": "string", + "nullable": true + }, + "iconURL": { + "type": "string", + "nullable": true + }, + "iconEmoji": { + "type": "string", + "nullable": true + } + } + }, "TextProcessingTask": { "type": "object", "required": [ @@ -3009,6 +3063,177 @@ } } }, + "/ocs/v2.php/teams/{teamId}/resources": { + "get": { + "operationId": "teams_api-resolve-one", + "summary": "Get all resources of a team", + "tags": [ + "teams_api" + ], + "security": [ + { + "bearer_auth": [] + }, + { + "basic_auth": [] + } + ], + "parameters": [ + { + "name": "teamId", + "in": "path", + "description": "Unique id of the team", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "OCS-APIRequest", + "in": "header", + "description": "Required to be true for the API request to pass", + "required": true, + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Resources returned", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TeamResource" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "/ocs/v2.php/teams/resources/{providerId}/{resourceId}": { + "get": { + "operationId": "teams_api-list-teams", + "summary": "Get all teams of a resource", + "tags": [ + "teams_api" + ], + "security": [ + { + "bearer_auth": [] + }, + { + "basic_auth": [] + } + ], + "parameters": [ + { + "name": "providerId", + "in": "path", + "description": "Identifier of the provider (e.g. deck, talk, collectives)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceId", + "in": "path", + "description": "Unique id of the resource to list teams for (e.g. deck board id)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "OCS-APIRequest", + "in": "header", + "description": "Required to be true for the API request to pass", + "required": true, + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Teams returned", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "required": [ + "teams" + ], + "properties": { + "teams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Team" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, "/ocs/v2.php/textprocessing/tasktypes": { "get": { "operationId": "text_processing_api-task-types", |