Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

files_external: Add OpenAPI spec #39321

Merged
merged 1 commit into from Jul 13, 2023
Merged

files_external: Add OpenAPI spec #39321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions apps/files_external/composer/composer/autoload_classmap.php
View file
Open in desktop
Expand Up @@ -105,6 +105,7 @@
'OCA\\Files_External\\Migration\\Version22000Date20210216084416' => $baseDir . '/../lib/Migration/Version22000Date20210216084416.php',
'OCA\\Files_External\\MountConfig' => $baseDir . '/../lib/MountConfig.php',
'OCA\\Files_External\\NotFoundException' => $baseDir . '/../lib/NotFoundException.php',
'OCA\\Files_External\\ResponseDefinitions' => $baseDir . '/../lib/ResponseDefinitions.php',
'OCA\\Files_External\\Service\\BackendService' => $baseDir . '/../lib/Service/BackendService.php',
'OCA\\Files_External\\Service\\DBConfigService' => $baseDir . '/../lib/Service/DBConfigService.php',
'OCA\\Files_External\\Service\\GlobalStoragesService' => $baseDir . '/../lib/Service/GlobalStoragesService.php',
Expand Down
1 change: 1 addition & 0 deletions apps/files_external/composer/composer/autoload_static.php
View file
Open in desktop
Expand Up @@ -120,6 +120,7 @@ class ComposerStaticInitFiles_External
'OCA\\Files_External\\Migration\\Version22000Date20210216084416' => __DIR__ . '/..' . '/../lib/Migration/Version22000Date20210216084416.php',
'OCA\\Files_External\\MountConfig' => __DIR__ . '/..' . '/../lib/MountConfig.php',
'OCA\\Files_External\\NotFoundException' => __DIR__ . '/..' . '/../lib/NotFoundException.php',
'OCA\\Files_External\\ResponseDefinitions' => __DIR__ . '/..' . '/../lib/ResponseDefinitions.php',
'OCA\\Files_External\\Service\\BackendService' => __DIR__ . '/..' . '/../lib/Service/BackendService.php',
'OCA\\Files_External\\Service\\DBConfigService' => __DIR__ . '/..' . '/../lib/Service/DBConfigService.php',
'OCA\\Files_External\\Service\\GlobalStoragesService' => __DIR__ . '/..' . '/../lib/Service/GlobalStoragesService.php',
Expand Down
11 changes: 8 additions & 3 deletions apps/files_external/lib/Controller/ApiController.php
View file
Open in desktop
Expand Up @@ -30,13 +30,18 @@
namespace OCA\Files_External\Controller;

use OCA\Files_External\Lib\StorageConfig;
use OCA\Files_External\ResponseDefinitions;
use OCA\Files_External\Service\UserGlobalStoragesService;
use OCA\Files_External\Service\UserStoragesService;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCSController;
use OCP\IRequest;
use OCP\IUserSession;

/**
* @psalm-import-type FilesExternalMount from ResponseDefinitions
*/
class ApiController extends OCSController {

/** @var IUserSession */
Expand Down Expand Up @@ -66,7 +71,7 @@ public function __construct(
* @param string $mountPoint mount point name, relative to the data dir
* @param StorageConfig $mountConfig mount config to format
*
* @return array entry
* @return FilesExternalMount
*/
private function formatMount(string $mountPoint, StorageConfig $mountConfig): array {
// split path from mount point
Expand Down Expand Up @@ -99,9 +104,9 @@ private function formatMount(string $mountPoint, StorageConfig $mountConfig): ar
/**
* @NoAdminRequired
*
* Returns the mount points visible for this user.
* Get the mount points visible for this user
*
* @return DataResponse share information
* @return DataResponse<Http::STATUS_OK, FilesExternalMount[], array{}>
*/
public function getUserMounts(): DataResponse {
$entries = [];
Expand Down
2 changes: 1 addition & 1 deletion apps/files_external/lib/Lib/StorageConfig.php
View file
Open in desktop
Expand Up @@ -136,7 +136,7 @@ public function __construct($id = null) {
/**
* Returns the configuration id
*
* @retun int
* @return int
*/
public function getId() {
return $this->id;
Expand Down
41 changes: 41 additions & 0 deletions apps/files_external/lib/ResponseDefinitions.php
View file
Open in desktop
@@ -0,0 +1,41 @@
<?php
declare(strict_types=1);

/**
* @copyright Copyright (c) 2023 Kate Döen <kate.doeen@nextcloud.com>
*
* @author Kate Döen <kate.doeen@nextcloud.com>
*
* @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 OCA\Files_External;

/**
* @psalm-type FilesExternalMount = array{
* name: string,
* path: string,
* type: 'dir',
* backend: string,
* scope: 'system'|'personal',
* permissions: int,
* id: int,
* class: string,
* }
*/
class ResponseDefinitions {
}
163 changes: 163 additions & 0 deletions apps/files_external/openapi.json
View file
Open in desktop
@@ -0,0 +1,163 @@
{
"openapi": "3.0.3",
"info": {
"title": "files_external",
"version": "0.0.1",
"description": "Adds basic external storage support",
"license": {
"name": "agpl"
}
},
"components": {
"securitySchemes": {
"basic_auth": {
"type": "http",
"scheme": "basic"
},
"bearer_auth": {
"type": "http",
"scheme": "bearer"
}
},
"schemas": {
"Mount": {
"type": "object",
"required": [
"name",
"path",
"type",
"backend",
"scope",
"permissions",
"id",
"class"
],
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"dir"
]
},
"backend": {
"type": "string"
},
"scope": {
"type": "string",
"enum": [
"system",
"personal"
]
},
"permissions": {
"type": "integer",
"format": "int64"
},
"id": {
"type": "integer",
"format": "int64"
},
"class": {
"type": "string"
}
}
},
"OCSMeta": {
"type": "object",
"required": [
"status",
"statuscode"
],
"properties": {
"status": {
"type": "string"
},
"statuscode": {
"type": "integer"
},
"message": {
"type": "string"
},
"totalitems": {
"type": "string"
},
"itemsperpage": {
"type": "string"
}
}
}
}
},
"paths": {
"/ocs/v2.php/apps/files_external/api/v1/mounts": {
"get": {
"operationId": "api-get-user-mounts",
"summary": "Get the mount points visible for this user",
"tags": [
"api"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "true"
provokateurin marked this conversation as resolved.
Show resolved Hide resolved
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Mount"
}
}
}
}
}
}
}
}
}
}
}
}
},
"tags": []
}