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.

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

fix(provisioning_api): Fix AppInfo schema for OpenAPI #43877

Merged
merged 1 commit into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions apps/provisioning_api/lib/Controller/AppsController.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
namespace OCA\Provisioning_API\Controller;

use OC_App;
use OCA\Provisioning_API\ResponseDefinitions;
use OCP\App\AppPathNotFoundException;
use OCP\App\IAppManager;
use OCP\AppFramework\Http;
Expand All @@ -39,9 +38,6 @@
use OCP\AppFramework\OCSController;
use OCP\IRequest;

/**
* @psalm-import-type Provisioning_APIAppInfo from ResponseDefinitions
*/
class AppsController extends OCSController {
/** @var IAppManager */
private $appManager;
Expand Down Expand Up @@ -94,7 +90,7 @@ public function getApps(?string $filter = null): DataResponse {
* Get the app info for an app
*
* @param string $app ID of the app
* @return DataResponse<Http::STATUS_OK, Provisioning_APIAppInfo, array{}>
* @return DataResponse<Http::STATUS_OK, array<string, ?mixed>, array{}>
* @throws OCSException
*
* 200: App info returned
Expand Down
42 changes: 0 additions & 42 deletions apps/provisioning_api/lib/ResponseDefinitions.php
Original file line number Diff line number Diff line change
Expand Up @@ -82,48 +82,6 @@
* websiteScope?: string,
* }
*
* @psalm-type Provisioning_APIAppInfo = array{
* active: bool|null,
* activity: ?mixed,
* author: ?mixed,
* background-jobs: ?mixed,
* bugs: ?mixed,
* category: ?mixed,
* collaboration: ?mixed,
* commands: ?mixed,
* default_enable: ?mixed,
* dependencies: ?mixed,
* description: string,
* discussion: ?mixed,
* documentation: ?mixed,
* groups: ?mixed,
* id: string,
* info: ?mixed,
* internal: bool|null,
* level: int|null,
* licence: ?mixed,
* name: string,
* namespace: ?mixed,
* navigations: ?mixed,
* preview: ?mixed,
* previewAsIcon: bool|null,
* public: ?mixed,
* remote: ?mixed,
* removable: bool|null,
* repair-steps: ?mixed,
* repository: ?mixed,
* sabre: ?mixed,
* screenshot: ?mixed,
* settings: ?mixed,
* summary: string,
* trash: ?mixed,
* two-factor-providers: ?mixed,
* types: ?mixed,
* version: string,
* versions: ?mixed,
* website: ?mixed,
* }
*
* @psalm-type Provisioning_APIGroupDetails = array{
* id: string,
* displayname: string,
Expand Down
204 changes: 5 additions & 199 deletions apps/provisioning_api/openapi-administration.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,204 +20,6 @@
}
},
"schemas": {
"AppInfo": {
"type": "object",
"required": [
"active",
"activity",
"author",
"background-jobs",
"bugs",
"category",
"collaboration",
"commands",
"default_enable",
"dependencies",
"description",
"discussion",
"documentation",
"groups",
"id",
"info",
"internal",
"level",
"licence",
"name",
"namespace",
"navigations",
"preview",
"previewAsIcon",
"public",
"remote",
"removable",
"repair-steps",
"repository",
"sabre",
"screenshot",
"settings",
"summary",
"trash",
"two-factor-providers",
"types",
"version",
"versions",
"website"
],
"properties": {
"active": {
"type": "boolean",
"nullable": true
},
"activity": {
"type": "object",
"nullable": true
},
"author": {
"type": "object",
"nullable": true
},
"background-jobs": {
"type": "object",
"nullable": true
},
"bugs": {
"type": "object",
"nullable": true
},
"category": {
"type": "object",
"nullable": true
},
"collaboration": {
"type": "object",
"nullable": true
},
"commands": {
"type": "object",
"nullable": true
},
"default_enable": {
"type": "object",
"nullable": true
},
"dependencies": {
"type": "object",
"nullable": true
},
"description": {
"type": "string"
},
"discussion": {
"type": "object",
"nullable": true
},
"documentation": {
"type": "object",
"nullable": true
},
"groups": {
"type": "object",
"nullable": true
},
"id": {
"type": "string"
},
"info": {
"type": "object",
"nullable": true
},
"internal": {
"type": "boolean",
"nullable": true
},
"level": {
"type": "integer",
"format": "int64",
"nullable": true
},
"licence": {
"type": "object",
"nullable": true
},
"name": {
"type": "string"
},
"namespace": {
"type": "object",
"nullable": true
},
"navigations": {
"type": "object",
"nullable": true
},
"preview": {
"type": "object",
"nullable": true
},
"previewAsIcon": {
"type": "boolean",
"nullable": true
},
"public": {
"type": "object",
"nullable": true
},
"remote": {
"type": "object",
"nullable": true
},
"removable": {
"type": "boolean",
"nullable": true
},
"repair-steps": {
"type": "object",
"nullable": true
},
"repository": {
"type": "object",
"nullable": true
},
"sabre": {
"type": "object",
"nullable": true
},
"screenshot": {
"type": "object",
"nullable": true
},
"settings": {
"type": "object",
"nullable": true
},
"summary": {
"type": "string"
},
"trash": {
"type": "object",
"nullable": true
},
"two-factor-providers": {
"type": "object",
"nullable": true
},
"types": {
"type": "object",
"nullable": true
},
"version": {
"type": "string"
},
"versions": {
"type": "object",
"nullable": true
},
"website": {
"type": "object",
"nullable": true
}
}
},
"Capabilities": {
"type": "object",
"required": [
Expand Down Expand Up @@ -418,7 +220,11 @@
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"$ref": "#/components/schemas/AppInfo"
"type": "object",
"additionalProperties": {
"type": "object",
"nullable": true
}
}
}
}
Expand Down
Loading
Loading