Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #39312 from nextcloud/feature/openapi/updatenotifi…
…cation updatenotification: Add OpenAPI spec
- Loading branch information
Showing
5 changed files
with
261 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| <?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\UpdateNotification; | ||
|
|
||
| /** | ||
| * @psalm-type UpdatenotificationApp = array{ | ||
| * appId: string, | ||
| * appName: string, | ||
| * } | ||
| */ | ||
| class ResponseDefinitions { | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,208 @@ | ||
| { | ||
| "openapi": "3.0.3", | ||
| "info": { | ||
| "title": "updatenotification", | ||
| "version": "0.0.1", | ||
| "description": "Displays update notifications for Nextcloud and provides the SSO for the updater.", | ||
| "license": { | ||
| "name": "agpl" | ||
| } | ||
| }, | ||
| "components": { | ||
| "securitySchemes": { | ||
| "basic_auth": { | ||
| "type": "http", | ||
| "scheme": "basic" | ||
| }, | ||
| "bearer_auth": { | ||
| "type": "http", | ||
| "scheme": "bearer" | ||
| } | ||
| }, | ||
| "schemas": { | ||
| "App": { | ||
| "type": "object", | ||
| "required": [ | ||
| "appId", | ||
| "appName" | ||
| ], | ||
| "properties": { | ||
| "appId": { | ||
| "type": "string" | ||
| }, | ||
| "appName": { | ||
| "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/updatenotification/api/{apiVersion}/applist/{newVersion}": { | ||
| "get": { | ||
| "operationId": "api-get-app-list", | ||
| "summary": "List available updates for apps", | ||
| "description": "This endpoint requires admin access", | ||
| "tags": [ | ||
| "api" | ||
| ], | ||
| "security": [ | ||
| { | ||
| "bearer_auth": [] | ||
| }, | ||
| { | ||
| "basic_auth": [] | ||
| } | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "name": "apiVersion", | ||
| "in": "path", | ||
| "required": true, | ||
| "schema": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "v1" | ||
| ], | ||
| "default": "v1" | ||
| } | ||
| }, | ||
| { | ||
| "name": "newVersion", | ||
| "in": "path", | ||
| "description": "Server version to check updates for", | ||
| "required": true, | ||
| "schema": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| { | ||
| "name": "OCS-APIRequest", | ||
| "in": "header", | ||
| "required": true, | ||
| "schema": { | ||
| "type": "string", | ||
| "default": "true" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Apps 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": [ | ||
| "missing", | ||
| "available" | ||
| ], | ||
| "properties": { | ||
| "missing": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/App" | ||
| } | ||
| }, | ||
| "available": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/App" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "404": { | ||
| "description": "New versions not found", | ||
| "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": [ | ||
| "appstore_disabled" | ||
| ], | ||
| "properties": { | ||
| "appstore_disabled": { | ||
| "type": "boolean" | ||
| }, | ||
| "already_on_latest": { | ||
| "type": "boolean" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "tags": [] | ||
| } |