diff --git a/openapi.json b/openapi.json index 42f11ea0c..dde063e0e 100644 --- a/openapi.json +++ b/openapi.json @@ -184,6 +184,30 @@ } } }, + "OCSMeta": { + "type": "object", + "required": [ + "status", + "statuscode" + ], + "properties": { + "status": { + "type": "string" + }, + "statuscode": { + "type": "integer" + }, + "message": { + "type": "string" + }, + "totalitems": { + "type": "string" + }, + "itemsperpage": { + "type": "string" + } + } + }, "User": { "type": "object", "required": [ @@ -235,9 +259,29 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DelegationGroup" + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DelegationGroup" + } + } + } + } } } } @@ -279,9 +323,29 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DelegationCircle" + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DelegationCircle" + } + } + } + } } } } @@ -332,9 +396,29 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DelegationGroup" + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DelegationGroup" + } + } + } + } } } } @@ -390,8 +474,28 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/Folder" + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Folder" + } + } + } + } } } } @@ -401,7 +505,27 @@ "description": "Storage not found", "content": { "application/json": { - "schema": {} + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": {} + } + } + } + } } } } @@ -459,7 +583,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Folder" + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "$ref": "#/components/schemas/Folder" + } + } + } + } } } } @@ -468,7 +612,27 @@ "description": "Groupfolder not found", "content": { "application/json": { - "schema": {} + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": {} + } + } + } + } } } } @@ -518,7 +682,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Folder" + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "$ref": "#/components/schemas/Folder" + } + } + } + } } } } @@ -527,7 +711,27 @@ "description": "Groupfolder not found", "content": { "application/json": { - "schema": {} + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": {} + } + } + } + } } } } @@ -578,14 +782,34 @@ "schema": { "type": "object", "required": [ - "success" + "ocs" ], "properties": { - "success": { - "type": "boolean", - "enum": [ - true - ] + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "success": { + "type": "boolean", + "enum": [ + true + ] + } + } + } + } } } } @@ -596,7 +820,27 @@ "description": "Groupfolder not found", "content": { "application/json": { - "schema": {} + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": {} + } + } + } + } } } } @@ -666,14 +910,34 @@ "schema": { "type": "object", "required": [ - "success" + "ocs" ], "properties": { - "success": { - "type": "boolean", - "enum": [ - true - ] + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "success": { + "type": "boolean", + "enum": [ + true + ] + } + } + } + } } } } @@ -748,14 +1012,34 @@ "schema": { "type": "object", "required": [ - "success" + "ocs" ], "properties": { - "success": { - "type": "boolean", - "enum": [ - true - ] + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "success": { + "type": "boolean", + "enum": [ + true + ] + } + } + } + } } } } @@ -766,7 +1050,27 @@ "description": "Groupfolder not found", "content": { "application/json": { - "schema": {} + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": {} + } + } + } + } } } } @@ -829,14 +1133,34 @@ "schema": { "type": "object", "required": [ - "success" + "ocs" ], "properties": { - "success": { - "type": "boolean", - "enum": [ - true - ] + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "success": { + "type": "boolean", + "enum": [ + true + ] + } + } + } + } } } } @@ -847,7 +1171,27 @@ "description": "Groupfolder not found", "content": { "application/json": { - "schema": {} + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": {} + } + } + } + } } } } @@ -928,14 +1272,34 @@ "schema": { "type": "object", "required": [ - "success" + "ocs" ], "properties": { - "success": { - "type": "boolean", - "enum": [ - true - ] + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "success": { + "type": "boolean", + "enum": [ + true + ] + } + } + } + } } } } @@ -946,7 +1310,27 @@ "description": "Groupfolder not found", "content": { "application/json": { - "schema": {} + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": {} + } + } + } + } } } } @@ -1028,14 +1412,34 @@ "schema": { "type": "object", "required": [ - "success" + "ocs" ], "properties": { - "success": { - "type": "boolean", - "enum": [ - true - ] + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "success": { + "type": "boolean", + "enum": [ + true + ] + } + } + } + } } } } @@ -1046,7 +1450,27 @@ "description": "Groupfolder not found", "content": { "application/json": { - "schema": {} + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": {} + } + } + } + } } } } @@ -1119,14 +1543,34 @@ "schema": { "type": "object", "required": [ - "success" + "ocs" ], "properties": { - "success": { - "type": "boolean", - "enum": [ - true - ] + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "success": { + "type": "boolean", + "enum": [ + true + ] + } + } + } + } } } } @@ -1137,7 +1581,27 @@ "description": "Groupfolder not found", "content": { "application/json": { - "schema": {} + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": {} + } + } + } + } } } } @@ -1209,14 +1673,34 @@ "schema": { "type": "object", "required": [ - "success" + "ocs" ], "properties": { - "success": { - "type": "boolean", - "enum": [ - true - ] + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "success": { + "type": "boolean", + "enum": [ + true + ] + } + } + } + } } } } @@ -1227,7 +1711,27 @@ "description": "Groupfolder not found", "content": { "application/json": { - "schema": {} + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": {} + } + } + } + } } } } @@ -1299,14 +1803,34 @@ "schema": { "type": "object", "required": [ - "success" + "ocs" ], "properties": { - "success": { - "type": "boolean", - "enum": [ - true - ] + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "success": { + "type": "boolean", + "enum": [ + true + ] + } + } + } + } } } } @@ -1317,7 +1841,27 @@ "description": "Groupfolder not found", "content": { "application/json": { - "schema": {} + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": {} + } + } + } + } } } } @@ -1378,20 +1922,40 @@ "schema": { "type": "object", "required": [ - "users", - "groups" + "ocs" ], "properties": { - "users": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } - }, - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Group" + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "required": [ + "users", + "groups" + ], + "properties": { + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Group" + } + } + } + } } } } @@ -1403,7 +1967,27 @@ "description": "Not allowed to search", "content": { "application/json": { - "schema": {} + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": {} + } + } + } + } } } } diff --git a/src/types/openapi/openapi.ts b/src/types/openapi/openapi.ts index 4420830e5..8ff944a60 100644 --- a/src/types/openapi/openapi.ts +++ b/src/types/openapi/openapi.ts @@ -294,6 +294,13 @@ export type components = { gid: string; displayname: string; }; + OCSMeta: { + status: string; + statuscode: number; + message?: string; + totalitems?: string; + itemsperpage?: string; + }; User: { uid: string; displayname: string; @@ -325,7 +332,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["DelegationGroup"][]; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: components["schemas"]["DelegationGroup"][]; + }; + }; }; }; }; @@ -348,7 +360,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["DelegationCircle"][]; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: components["schemas"]["DelegationCircle"][]; + }; + }; }; }; }; @@ -374,7 +391,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["DelegationGroup"][]; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: components["schemas"]["DelegationGroup"][]; + }; + }; }; }; }; @@ -401,7 +423,12 @@ export interface operations { }; content: { "application/json": { - [key: string]: components["schemas"]["Folder"]; + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: { + [key: string]: components["schemas"]["Folder"]; + }; + }; }; }; }; @@ -411,7 +438,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": unknown; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: unknown; + }; + }; }; }; }; @@ -441,7 +473,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["Folder"]; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: components["schemas"]["Folder"]; + }; + }; }; }; /** @description Groupfolder not found */ @@ -450,7 +487,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": unknown; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: unknown; + }; + }; }; }; }; @@ -476,7 +518,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["Folder"]; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: components["schemas"]["Folder"]; + }; + }; }; }; /** @description Groupfolder not found */ @@ -485,7 +532,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": unknown; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: unknown; + }; + }; }; }; }; @@ -519,8 +571,13 @@ export interface operations { }; content: { "application/json": { - /** @enum {boolean} */ - success: true; + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: { + /** @enum {boolean} */ + success: true; + }; + }; }; }; }; @@ -548,8 +605,13 @@ export interface operations { }; content: { "application/json": { - /** @enum {boolean} */ - success: true; + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: { + /** @enum {boolean} */ + success: true; + }; + }; }; }; }; @@ -559,7 +621,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": unknown; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: unknown; + }; + }; }; }; }; @@ -593,8 +660,13 @@ export interface operations { }; content: { "application/json": { - /** @enum {boolean} */ - success: true; + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: { + /** @enum {boolean} */ + success: true; + }; + }; }; }; }; @@ -604,7 +676,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": unknown; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: unknown; + }; + }; }; }; }; @@ -643,8 +720,13 @@ export interface operations { }; content: { "application/json": { - /** @enum {boolean} */ - success: true; + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: { + /** @enum {boolean} */ + success: true; + }; + }; }; }; }; @@ -654,7 +736,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": unknown; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: unknown; + }; + }; }; }; }; @@ -683,8 +770,13 @@ export interface operations { }; content: { "application/json": { - /** @enum {boolean} */ - success: true; + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: { + /** @enum {boolean} */ + success: true; + }; + }; }; }; }; @@ -694,7 +786,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": unknown; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: unknown; + }; + }; }; }; }; @@ -732,8 +829,13 @@ export interface operations { }; content: { "application/json": { - /** @enum {boolean} */ - success: true; + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: { + /** @enum {boolean} */ + success: true; + }; + }; }; }; }; @@ -743,7 +845,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": unknown; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: unknown; + }; + }; }; }; }; @@ -780,8 +887,13 @@ export interface operations { }; content: { "application/json": { - /** @enum {boolean} */ - success: true; + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: { + /** @enum {boolean} */ + success: true; + }; + }; }; }; }; @@ -791,7 +903,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": unknown; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: unknown; + }; + }; }; }; }; @@ -825,8 +942,13 @@ export interface operations { }; content: { "application/json": { - /** @enum {boolean} */ - success: true; + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: { + /** @enum {boolean} */ + success: true; + }; + }; }; }; }; @@ -836,7 +958,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": unknown; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: unknown; + }; + }; }; }; }; @@ -870,8 +997,13 @@ export interface operations { }; content: { "application/json": { - /** @enum {boolean} */ - success: true; + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: { + /** @enum {boolean} */ + success: true; + }; + }; }; }; }; @@ -881,7 +1013,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": unknown; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: unknown; + }; + }; }; }; }; @@ -911,8 +1048,13 @@ export interface operations { }; content: { "application/json": { - users: components["schemas"]["User"][]; - groups: components["schemas"]["Group"][]; + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: { + users: components["schemas"]["User"][]; + groups: components["schemas"]["Group"][]; + }; + }; }; }; }; @@ -922,7 +1064,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": unknown; + "application/json": { + ocs: { + meta: components["schemas"]["OCSMeta"]; + data: unknown; + }; + }; }; }; }; diff --git a/vendor-bin/openapi-extractor/composer.lock b/vendor-bin/openapi-extractor/composer.lock index df45fe707..b30d7164a 100644 --- a/vendor-bin/openapi-extractor/composer.lock +++ b/vendor-bin/openapi-extractor/composer.lock @@ -79,16 +79,16 @@ }, { "name": "nextcloud/openapi-extractor", - "version": "v1.2.0", + "version": "v1.2.2", "source": { "type": "git", "url": "https://github.com/nextcloud-releases/openapi-extractor.git", - "reference": "b8b55ccb2407bb7a073a482293fbf0067186313c" + "reference": "fb177110c9d182dd9c6c5c19d20f1275f2b7f6af" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/nextcloud-releases/openapi-extractor/zipball/b8b55ccb2407bb7a073a482293fbf0067186313c", - "reference": "b8b55ccb2407bb7a073a482293fbf0067186313c", + "url": "https://api.github.com/repos/nextcloud-releases/openapi-extractor/zipball/fb177110c9d182dd9c6c5c19d20f1275f2b7f6af", + "reference": "fb177110c9d182dd9c6c5c19d20f1275f2b7f6af", "shasum": "" }, "require": { @@ -119,9 +119,9 @@ "description": "A tool for extracting OpenAPI specifications from Nextcloud source code", "support": { "issues": "https://github.com/nextcloud-releases/openapi-extractor/issues", - "source": "https://github.com/nextcloud-releases/openapi-extractor/tree/v1.2.0" + "source": "https://github.com/nextcloud-releases/openapi-extractor/tree/v1.2.2" }, - "time": "2024-11-11T14:31:25+00:00" + "time": "2024-11-13T10:36:57+00:00" }, { "name": "nikic/php-parser",