mirror of https://github.com/nextcloud/server.git
Merge pull request #39331 from nextcloud/feature/openapi/core
core: Add OpenAPI specpull/39291/head
Robin Appelman
11 months ago
committed by
GitHub
commit
c988d782eb
@ -0,0 +1,131 @@
|
||||
<?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\Core;
|
||||
|
||||
/**
|
||||
* @psalm-type CoreLoginFlowV2Credentials = array{
|
||||
* server: string,
|
||||
* loginName: string,
|
||||
* appPassword: string,
|
||||
* }
|
||||
*
|
||||
* @psalm-type CoreLoginFlowV2 = array{
|
||||
* poll: array{
|
||||
* token: string,
|
||||
* endpoint: string,
|
||||
* },
|
||||
* login: string,
|
||||
* }
|
||||
*
|
||||
* @psalm-type CoreNavigationEntry = array{
|
||||
* id: string,
|
||||
* order: int|string,
|
||||
* href: string,
|
||||
* icon: string,
|
||||
* type: string,
|
||||
* name: string,
|
||||
* active: bool,
|
||||
* classes: string,
|
||||
* unread: int,
|
||||
* }
|
||||
*
|
||||
* @psalm-type CoreContactsAction = array{
|
||||
* title: string,
|
||||
* icon: string,
|
||||
* hyperlink: string,
|
||||
* appId: string,
|
||||
* }
|
||||
*
|
||||
* @psalm-type CoreOpenGraphObject = array{
|
||||
* richObjectType: string,
|
||||
* richObject: array<string, mixed>,
|
||||
* openGraphObject: array{
|
||||
* id: string,
|
||||
* name: string,
|
||||
* description: ?string,
|
||||
* thumb: ?string,
|
||||
* link: string,
|
||||
* },
|
||||
* accessible: bool,
|
||||
* }
|
||||
*
|
||||
* @psalm-type CoreCollection = array{
|
||||
* id: int,
|
||||
* name: string,
|
||||
* resources: CoreOpenGraphObject[],
|
||||
* }
|
||||
*
|
||||
* @psalm-type CoreReference = array{
|
||||
* richObjectType: string,
|
||||
* richObject: array<string, mixed>,
|
||||
* openGraphObject: CoreOpenGraphObject,
|
||||
* accessible: bool,
|
||||
* }
|
||||
*
|
||||
* @psalm-type CoreReferenceProvider = array{
|
||||
* id: string,
|
||||
* title: string,
|
||||
* icon_url: string,
|
||||
* order: int,
|
||||
* search_providers_ids: ?string[]
|
||||
* }
|
||||
*
|
||||
* @psalm-type CoreUnifiedSearchProvider = array{
|
||||
* id: string,
|
||||
* name: string,
|
||||
* order: int,
|
||||
* }
|
||||
*
|
||||
* @psalm-type CoreUnifiedSearchResultEntry = array{
|
||||
* thumbnailUrl: string,
|
||||
* title: string,
|
||||
* subline: string,
|
||||
* resourceUrl: string,
|
||||
* icon: string,
|
||||
* rounded: bool,
|
||||
* attributes: string[],
|
||||
* }
|
||||
*
|
||||
* @psalm-type CoreUnifiedSearchResult = array{
|
||||
* name: string,
|
||||
* isPaginated: bool,
|
||||
* entries: CoreUnifiedSearchResultEntry[],
|
||||
* cursor: int|string|null,
|
||||
* }
|
||||
*
|
||||
* @psalm-type CoreAutocompleteResult = array{
|
||||
* id: string,
|
||||
* label: string,
|
||||
* icon: string,
|
||||
* source: string,
|
||||
* status: string,
|
||||
* subline: string,
|
||||
* shareWithDisplayNameUnique: string,
|
||||
* }
|
||||
*/
|
||||
class ResponseDefinitions {
|
||||
}
|
||||
Loading…
Reference in New Issue