chore: make group nullable and remove it from endpoints where its not required

This commit is contained in:
Chirag Aggarwal
2025-04-12 06:41:57 +00:00
parent 2a7038bb8e
commit 04733e25c8
17 changed files with 201 additions and 698 deletions
+15 -93
View File
@@ -3275,7 +3275,7 @@
},
"x-appwrite": {
"method": "getBrowser",
"group": "icons",
"group": null,
"weight": 60,
"cookies": false,
"type": "location",
@@ -3401,7 +3401,7 @@
},
"x-appwrite": {
"method": "getCreditCard",
"group": "icons",
"group": null,
"weight": 59,
"cookies": false,
"type": "location",
@@ -3533,7 +3533,7 @@
},
"x-appwrite": {
"method": "getFavicon",
"group": "images",
"group": null,
"weight": 63,
"cookies": false,
"type": "location",
@@ -3591,7 +3591,7 @@
},
"x-appwrite": {
"method": "getFlag",
"group": "icons",
"group": null,
"weight": 61,
"cookies": false,
"type": "location",
@@ -4079,7 +4079,7 @@
},
"x-appwrite": {
"method": "getImage",
"group": "images",
"group": null,
"weight": 62,
"cookies": false,
"type": "location",
@@ -4161,7 +4161,7 @@
},
"x-appwrite": {
"method": "getInitials",
"group": "images",
"group": null,
"weight": 65,
"cookies": false,
"type": "location",
@@ -4253,7 +4253,7 @@
},
"x-appwrite": {
"method": "getQR",
"group": "images",
"group": null,
"weight": 64,
"cookies": false,
"type": "location",
@@ -5201,7 +5201,7 @@
},
"x-appwrite": {
"method": "get",
"group": "locale",
"group": null,
"weight": 117,
"cookies": false,
"type": "",
@@ -5253,7 +5253,7 @@
},
"x-appwrite": {
"method": "listCodes",
"group": "locale",
"group": null,
"weight": 118,
"cookies": false,
"type": "",
@@ -5305,7 +5305,7 @@
},
"x-appwrite": {
"method": "listContinents",
"group": "continents",
"group": null,
"weight": 122,
"cookies": false,
"type": "",
@@ -5357,7 +5357,7 @@
},
"x-appwrite": {
"method": "listCountries",
"group": "countries",
"group": null,
"weight": 119,
"cookies": false,
"type": "",
@@ -5409,7 +5409,7 @@
},
"x-appwrite": {
"method": "listCountriesEU",
"group": "countries",
"group": null,
"weight": 120,
"cookies": false,
"type": "",
@@ -5461,7 +5461,7 @@
},
"x-appwrite": {
"method": "listCountriesPhones",
"group": "countries",
"group": null,
"weight": 121,
"cookies": false,
"type": "",
@@ -5513,7 +5513,7 @@
},
"x-appwrite": {
"method": "listCurrencies",
"group": "currencies",
"group": null,
"weight": 123,
"cookies": false,
"type": "",
@@ -5565,7 +5565,7 @@
},
"x-appwrite": {
"method": "listLanguages",
"group": "languages",
"group": null,
"weight": 124,
"cookies": false,
"type": "",
@@ -6456,84 +6456,6 @@
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/push": {
"get": {
"summary": "Get file for push notification",
"operationId": "storageGetFilePush",
"tags": [
"storage"
],
"description": "Get a file for push notification by its unique ID. This endpoint response returns a JSON object with the file metadata.",
"responses": {
"200": {
"description": "File"
}
},
"x-appwrite": {
"method": "getFilePush",
"group": "files",
"weight": 213,
"cookies": false,
"type": "location",
"deprecated": false,
"demo": "storage\/get-file-push.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-push.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "public",
"platforms": [
"client",
"server",
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Session": [],
"JWT": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
},
{
"name": "fileId",
"description": "File ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FILE_ID>"
},
"in": "path"
},
{
"name": "jwt",
"description": "JSON Web Token to validate",
"required": false,
"schema": {
"type": "string",
"x-example": "<JWT>",
"default": ""
},
"in": "query"
}
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": {
"get": {
"summary": "Get file for view",
+46 -124
View File
@@ -3280,7 +3280,7 @@
},
"x-appwrite": {
"method": "getBrowser",
"group": "icons",
"group": null,
"weight": 60,
"cookies": false,
"type": "location",
@@ -3406,7 +3406,7 @@
},
"x-appwrite": {
"method": "getCreditCard",
"group": "icons",
"group": null,
"weight": 59,
"cookies": false,
"type": "location",
@@ -3538,7 +3538,7 @@
},
"x-appwrite": {
"method": "getFavicon",
"group": "images",
"group": null,
"weight": 63,
"cookies": false,
"type": "location",
@@ -3596,7 +3596,7 @@
},
"x-appwrite": {
"method": "getFlag",
"group": "icons",
"group": null,
"weight": 61,
"cookies": false,
"type": "location",
@@ -4084,7 +4084,7 @@
},
"x-appwrite": {
"method": "getImage",
"group": "images",
"group": null,
"weight": 62,
"cookies": false,
"type": "location",
@@ -4166,7 +4166,7 @@
},
"x-appwrite": {
"method": "getInitials",
"group": "images",
"group": null,
"weight": 65,
"cookies": false,
"type": "location",
@@ -4258,7 +4258,7 @@
},
"x-appwrite": {
"method": "getQR",
"group": "images",
"group": null,
"weight": 64,
"cookies": false,
"type": "location",
@@ -4617,7 +4617,7 @@
},
"x-appwrite": {
"method": "getUsage",
"group": "usage",
"group": null,
"weight": 114,
"cookies": false,
"type": "",
@@ -8842,7 +8842,7 @@
},
"x-appwrite": {
"method": "getCollectionUsage",
"group": "usage",
"group": null,
"weight": 116,
"cookies": false,
"type": "",
@@ -9007,7 +9007,7 @@
},
"x-appwrite": {
"method": "getDatabaseUsage",
"group": "usage",
"group": null,
"weight": 115,
"cookies": false,
"type": "",
@@ -9668,7 +9668,7 @@
},
"x-appwrite": {
"method": "getUsage",
"group": "usage",
"group": null,
"weight": 294,
"cookies": false,
"type": "",
@@ -11017,7 +11017,7 @@
},
"x-appwrite": {
"method": "getFunctionUsage",
"group": "usage",
"group": null,
"weight": 293,
"cookies": false,
"type": "",
@@ -12932,7 +12932,7 @@
},
"x-appwrite": {
"method": "get",
"group": "locale",
"group": null,
"weight": 117,
"cookies": false,
"type": "",
@@ -12984,7 +12984,7 @@
},
"x-appwrite": {
"method": "listCodes",
"group": "locale",
"group": null,
"weight": 118,
"cookies": false,
"type": "",
@@ -13036,7 +13036,7 @@
},
"x-appwrite": {
"method": "listContinents",
"group": "continents",
"group": null,
"weight": 122,
"cookies": false,
"type": "",
@@ -13088,7 +13088,7 @@
},
"x-appwrite": {
"method": "listCountries",
"group": "countries",
"group": null,
"weight": 119,
"cookies": false,
"type": "",
@@ -13140,7 +13140,7 @@
},
"x-appwrite": {
"method": "listCountriesEU",
"group": "countries",
"group": null,
"weight": 120,
"cookies": false,
"type": "",
@@ -13192,7 +13192,7 @@
},
"x-appwrite": {
"method": "listCountriesPhones",
"group": "countries",
"group": null,
"weight": 121,
"cookies": false,
"type": "",
@@ -13244,7 +13244,7 @@
},
"x-appwrite": {
"method": "listCurrencies",
"group": "currencies",
"group": null,
"weight": 123,
"cookies": false,
"type": "",
@@ -13296,7 +13296,7 @@
},
"x-appwrite": {
"method": "listLanguages",
"group": "languages",
"group": null,
"weight": 124,
"cookies": false,
"type": "",
@@ -17721,7 +17721,7 @@
},
"x-appwrite": {
"method": "list",
"group": "migrations",
"group": null,
"weight": 338,
"cookies": false,
"type": "",
@@ -17795,7 +17795,7 @@
},
"x-appwrite": {
"method": "createAppwriteMigration",
"group": "appwrite",
"group": null,
"weight": 334,
"cookies": false,
"type": "",
@@ -17883,7 +17883,7 @@
},
"x-appwrite": {
"method": "getAppwriteReport",
"group": "appwrite",
"group": null,
"weight": 340,
"cookies": false,
"type": "",
@@ -17976,7 +17976,7 @@
},
"x-appwrite": {
"method": "createFirebaseMigration",
"group": "firebase",
"group": null,
"weight": 335,
"cookies": false,
"type": "",
@@ -18052,7 +18052,7 @@
},
"x-appwrite": {
"method": "getFirebaseReport",
"group": "firebase",
"group": null,
"weight": 341,
"cookies": false,
"type": "",
@@ -18124,7 +18124,7 @@
},
"x-appwrite": {
"method": "createNHostMigration",
"group": "nhost",
"group": null,
"weight": 337,
"cookies": false,
"type": "",
@@ -18235,7 +18235,7 @@
},
"x-appwrite": {
"method": "getNHostReport",
"group": "nhost",
"group": null,
"weight": 343,
"cookies": false,
"type": "",
@@ -18368,7 +18368,7 @@
},
"x-appwrite": {
"method": "createSupabaseMigration",
"group": "supabase",
"group": null,
"weight": 336,
"cookies": false,
"type": "",
@@ -18473,7 +18473,7 @@
},
"x-appwrite": {
"method": "getSupabaseReport",
"group": "supabase",
"group": null,
"weight": 342,
"cookies": false,
"type": "",
@@ -18597,7 +18597,7 @@
},
"x-appwrite": {
"method": "get",
"group": "migrations",
"group": null,
"weight": 339,
"cookies": false,
"type": "",
@@ -18655,7 +18655,7 @@
},
"x-appwrite": {
"method": "retry",
"group": "migrations",
"group": null,
"weight": 344,
"cookies": false,
"type": "",
@@ -18706,7 +18706,7 @@
},
"x-appwrite": {
"method": "delete",
"group": "migrations",
"group": null,
"weight": 345,
"cookies": false,
"type": "",
@@ -18766,7 +18766,7 @@
},
"x-appwrite": {
"method": "getUsage",
"group": "usage",
"group": null,
"weight": 196,
"cookies": false,
"type": "",
@@ -18854,7 +18854,7 @@
},
"x-appwrite": {
"method": "listVariables",
"group": "variables",
"group": null,
"weight": 198,
"cookies": false,
"type": "",
@@ -18900,7 +18900,7 @@
},
"x-appwrite": {
"method": "createVariable",
"group": "variables",
"group": null,
"weight": 197,
"cookies": false,
"type": "",
@@ -18973,7 +18973,7 @@
},
"x-appwrite": {
"method": "getVariable",
"group": "variables",
"group": null,
"weight": 199,
"cookies": false,
"type": "",
@@ -19031,7 +19031,7 @@
},
"x-appwrite": {
"method": "updateVariable",
"group": "variables",
"group": null,
"weight": 200,
"cookies": false,
"type": "",
@@ -19106,7 +19106,7 @@
},
"x-appwrite": {
"method": "deleteVariable",
"group": "variables",
"group": null,
"weight": 201,
"cookies": false,
"type": "",
@@ -24021,7 +24021,7 @@
},
"x-appwrite": {
"method": "listRules",
"group": "rules",
"group": null,
"weight": 317,
"cookies": false,
"type": "",
@@ -24093,7 +24093,7 @@
},
"x-appwrite": {
"method": "createRule",
"group": "rules",
"group": null,
"weight": 316,
"cookies": false,
"type": "",
@@ -24177,7 +24177,7 @@
},
"x-appwrite": {
"method": "getRule",
"group": "rules",
"group": null,
"weight": 318,
"cookies": false,
"type": "",
@@ -24228,7 +24228,7 @@
},
"x-appwrite": {
"method": "deleteRule",
"group": "rules",
"group": null,
"weight": 319,
"cookies": false,
"type": "",
@@ -24288,7 +24288,7 @@
},
"x-appwrite": {
"method": "updateRuleVerification",
"group": "rules",
"group": null,
"weight": 320,
"cookies": false,
"type": "",
@@ -25473,84 +25473,6 @@
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/push": {
"get": {
"summary": "Get file for push notification",
"operationId": "storageGetFilePush",
"tags": [
"storage"
],
"description": "Get a file for push notification by its unique ID. This endpoint response returns a JSON object with the file metadata.",
"responses": {
"200": {
"description": "File"
}
},
"x-appwrite": {
"method": "getFilePush",
"group": "files",
"weight": 213,
"cookies": false,
"type": "location",
"deprecated": false,
"demo": "storage\/get-file-push.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-push.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "public",
"platforms": [
"client",
"server",
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
},
{
"name": "fileId",
"description": "File ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FILE_ID>"
},
"in": "path"
},
{
"name": "jwt",
"description": "JSON Web Token to validate",
"required": false,
"schema": {
"type": "string",
"x-example": "<JWT>",
"default": ""
},
"in": "query"
}
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": {
"get": {
"summary": "Get file for view",
@@ -25640,7 +25562,7 @@
},
"x-appwrite": {
"method": "getUsage",
"group": "usage",
"group": null,
"weight": 216,
"cookies": false,
"type": "",
@@ -25712,7 +25634,7 @@
},
"x-appwrite": {
"method": "getBucketUsage",
"group": "usage",
"group": null,
"weight": 217,
"cookies": false,
"type": "",
@@ -27849,7 +27771,7 @@
},
"x-appwrite": {
"method": "getUsage",
"group": "usage",
"group": null,
"weight": 274,
"cookies": false,
"type": "",
+15 -95
View File
@@ -2961,7 +2961,7 @@
},
"x-appwrite": {
"method": "getBrowser",
"group": "icons",
"group": null,
"weight": 60,
"cookies": false,
"type": "location",
@@ -3089,7 +3089,7 @@
},
"x-appwrite": {
"method": "getCreditCard",
"group": "icons",
"group": null,
"weight": 59,
"cookies": false,
"type": "location",
@@ -3223,7 +3223,7 @@
},
"x-appwrite": {
"method": "getFavicon",
"group": "images",
"group": null,
"weight": 63,
"cookies": false,
"type": "location",
@@ -3283,7 +3283,7 @@
},
"x-appwrite": {
"method": "getFlag",
"group": "icons",
"group": null,
"weight": 61,
"cookies": false,
"type": "location",
@@ -3773,7 +3773,7 @@
},
"x-appwrite": {
"method": "getImage",
"group": "images",
"group": null,
"weight": 62,
"cookies": false,
"type": "location",
@@ -3857,7 +3857,7 @@
},
"x-appwrite": {
"method": "getInitials",
"group": "images",
"group": null,
"weight": 65,
"cookies": false,
"type": "location",
@@ -3951,7 +3951,7 @@
},
"x-appwrite": {
"method": "getQR",
"group": "images",
"group": null,
"weight": 64,
"cookies": false,
"type": "location",
@@ -11811,7 +11811,7 @@
},
"x-appwrite": {
"method": "get",
"group": "locale",
"group": null,
"weight": 117,
"cookies": false,
"type": "",
@@ -11865,7 +11865,7 @@
},
"x-appwrite": {
"method": "listCodes",
"group": "locale",
"group": null,
"weight": 118,
"cookies": false,
"type": "",
@@ -11919,7 +11919,7 @@
},
"x-appwrite": {
"method": "listContinents",
"group": "continents",
"group": null,
"weight": 122,
"cookies": false,
"type": "",
@@ -11973,7 +11973,7 @@
},
"x-appwrite": {
"method": "listCountries",
"group": "countries",
"group": null,
"weight": 119,
"cookies": false,
"type": "",
@@ -12027,7 +12027,7 @@
},
"x-appwrite": {
"method": "listCountriesEU",
"group": "countries",
"group": null,
"weight": 120,
"cookies": false,
"type": "",
@@ -12081,7 +12081,7 @@
},
"x-appwrite": {
"method": "listCountriesPhones",
"group": "countries",
"group": null,
"weight": 121,
"cookies": false,
"type": "",
@@ -12135,7 +12135,7 @@
},
"x-appwrite": {
"method": "listCurrencies",
"group": "currencies",
"group": null,
"weight": 123,
"cookies": false,
"type": "",
@@ -12189,7 +12189,7 @@
},
"x-appwrite": {
"method": "listLanguages",
"group": "languages",
"group": null,
"weight": 124,
"cookies": false,
"type": "",
@@ -17808,86 +17808,6 @@
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/push": {
"get": {
"summary": "Get file for push notification",
"operationId": "storageGetFilePush",
"tags": [
"storage"
],
"description": "Get a file for push notification by its unique ID. This endpoint response returns a JSON object with the file metadata.",
"responses": {
"200": {
"description": "File"
}
},
"x-appwrite": {
"method": "getFilePush",
"group": "files",
"weight": 213,
"cookies": false,
"type": "location",
"deprecated": false,
"demo": "storage\/get-file-push.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-push.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "public",
"platforms": [
"client",
"server",
"server"
],
"packaging": false,
"auth": {
"Project": [],
"Session": []
}
},
"security": [
{
"Project": [],
"Session": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
},
{
"name": "fileId",
"description": "File ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FILE_ID>"
},
"in": "path"
},
{
"name": "jwt",
"description": "JSON Web Token to validate",
"required": false,
"schema": {
"type": "string",
"x-example": "<JWT>",
"default": ""
},
"in": "query"
}
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": {
"get": {
"summary": "Get file for view",
+15 -96
View File
@@ -3448,7 +3448,7 @@
},
"x-appwrite": {
"method": "getBrowser",
"group": "icons",
"group": null,
"weight": 60,
"cookies": false,
"type": "location",
@@ -3575,7 +3575,7 @@
},
"x-appwrite": {
"method": "getCreditCard",
"group": "icons",
"group": null,
"weight": 59,
"cookies": false,
"type": "location",
@@ -3708,7 +3708,7 @@
},
"x-appwrite": {
"method": "getFavicon",
"group": "images",
"group": null,
"weight": 63,
"cookies": false,
"type": "location",
@@ -3773,7 +3773,7 @@
},
"x-appwrite": {
"method": "getFlag",
"group": "icons",
"group": null,
"weight": 61,
"cookies": false,
"type": "location",
@@ -4262,7 +4262,7 @@
},
"x-appwrite": {
"method": "getImage",
"group": "images",
"group": null,
"weight": 62,
"cookies": false,
"type": "location",
@@ -4347,7 +4347,7 @@
},
"x-appwrite": {
"method": "getInitials",
"group": "images",
"group": null,
"weight": 65,
"cookies": false,
"type": "location",
@@ -4440,7 +4440,7 @@
},
"x-appwrite": {
"method": "getQR",
"group": "images",
"group": null,
"weight": 64,
"cookies": false,
"type": "location",
@@ -5410,7 +5410,7 @@
},
"x-appwrite": {
"method": "get",
"group": "locale",
"group": null,
"weight": 117,
"cookies": false,
"type": "",
@@ -5464,7 +5464,7 @@
},
"x-appwrite": {
"method": "listCodes",
"group": "locale",
"group": null,
"weight": 118,
"cookies": false,
"type": "",
@@ -5518,7 +5518,7 @@
},
"x-appwrite": {
"method": "listContinents",
"group": "continents",
"group": null,
"weight": 122,
"cookies": false,
"type": "",
@@ -5572,7 +5572,7 @@
},
"x-appwrite": {
"method": "listCountries",
"group": "countries",
"group": null,
"weight": 119,
"cookies": false,
"type": "",
@@ -5626,7 +5626,7 @@
},
"x-appwrite": {
"method": "listCountriesEU",
"group": "countries",
"group": null,
"weight": 120,
"cookies": false,
"type": "",
@@ -5680,7 +5680,7 @@
},
"x-appwrite": {
"method": "listCountriesPhones",
"group": "countries",
"group": null,
"weight": 121,
"cookies": false,
"type": "",
@@ -5734,7 +5734,7 @@
},
"x-appwrite": {
"method": "listCurrencies",
"group": "currencies",
"group": null,
"weight": 123,
"cookies": false,
"type": "",
@@ -5788,7 +5788,7 @@
},
"x-appwrite": {
"method": "listLanguages",
"group": "languages",
"group": null,
"weight": 124,
"cookies": false,
"type": "",
@@ -6654,87 +6654,6 @@
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/push": {
"get": {
"summary": "Get file for push notification",
"operationId": "storageGetFilePush",
"consumes": [
"application\/json"
],
"produces": [
"*\/*"
],
"tags": [
"storage"
],
"description": "Get a file for push notification by its unique ID. This endpoint response returns a JSON object with the file metadata.",
"responses": {
"200": {
"description": "File",
"schema": {
"type": "file"
}
}
},
"x-appwrite": {
"method": "getFilePush",
"group": "files",
"weight": 213,
"cookies": false,
"type": "location",
"deprecated": false,
"demo": "storage\/get-file-push.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-push.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "public",
"platforms": [
"client",
"server",
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Session": [],
"JWT": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"type": "string",
"x-example": "<BUCKET_ID>",
"in": "path"
},
{
"name": "fileId",
"description": "File ID.",
"required": true,
"type": "string",
"x-example": "<FILE_ID>",
"in": "path"
},
{
"name": "jwt",
"description": "JSON Web Token to validate",
"required": false,
"type": "string",
"x-example": "<JWT>",
"default": "",
"in": "query"
}
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": {
"get": {
"summary": "Get file for view",
+46 -127
View File
@@ -3469,7 +3469,7 @@
},
"x-appwrite": {
"method": "getBrowser",
"group": "icons",
"group": null,
"weight": 60,
"cookies": false,
"type": "location",
@@ -3596,7 +3596,7 @@
},
"x-appwrite": {
"method": "getCreditCard",
"group": "icons",
"group": null,
"weight": 59,
"cookies": false,
"type": "location",
@@ -3729,7 +3729,7 @@
},
"x-appwrite": {
"method": "getFavicon",
"group": "images",
"group": null,
"weight": 63,
"cookies": false,
"type": "location",
@@ -3794,7 +3794,7 @@
},
"x-appwrite": {
"method": "getFlag",
"group": "icons",
"group": null,
"weight": 61,
"cookies": false,
"type": "location",
@@ -4283,7 +4283,7 @@
},
"x-appwrite": {
"method": "getImage",
"group": "images",
"group": null,
"weight": 62,
"cookies": false,
"type": "location",
@@ -4368,7 +4368,7 @@
},
"x-appwrite": {
"method": "getInitials",
"group": "images",
"group": null,
"weight": 65,
"cookies": false,
"type": "location",
@@ -4461,7 +4461,7 @@
},
"x-appwrite": {
"method": "getQR",
"group": "images",
"group": null,
"weight": 64,
"cookies": false,
"type": "location",
@@ -4830,7 +4830,7 @@
},
"x-appwrite": {
"method": "getUsage",
"group": "usage",
"group": null,
"weight": 114,
"cookies": false,
"type": "",
@@ -8998,7 +8998,7 @@
},
"x-appwrite": {
"method": "getCollectionUsage",
"group": "usage",
"group": null,
"weight": 116,
"cookies": false,
"type": "",
@@ -9158,7 +9158,7 @@
},
"x-appwrite": {
"method": "getDatabaseUsage",
"group": "usage",
"group": null,
"weight": 115,
"cookies": false,
"type": "",
@@ -9840,7 +9840,7 @@
},
"x-appwrite": {
"method": "getUsage",
"group": "usage",
"group": null,
"weight": 294,
"cookies": false,
"type": "",
@@ -11198,7 +11198,7 @@
},
"x-appwrite": {
"method": "getFunctionUsage",
"group": "usage",
"group": null,
"weight": 293,
"cookies": false,
"type": "",
@@ -13163,7 +13163,7 @@
},
"x-appwrite": {
"method": "get",
"group": "locale",
"group": null,
"weight": 117,
"cookies": false,
"type": "",
@@ -13217,7 +13217,7 @@
},
"x-appwrite": {
"method": "listCodes",
"group": "locale",
"group": null,
"weight": 118,
"cookies": false,
"type": "",
@@ -13271,7 +13271,7 @@
},
"x-appwrite": {
"method": "listContinents",
"group": "continents",
"group": null,
"weight": 122,
"cookies": false,
"type": "",
@@ -13325,7 +13325,7 @@
},
"x-appwrite": {
"method": "listCountries",
"group": "countries",
"group": null,
"weight": 119,
"cookies": false,
"type": "",
@@ -13379,7 +13379,7 @@
},
"x-appwrite": {
"method": "listCountriesEU",
"group": "countries",
"group": null,
"weight": 120,
"cookies": false,
"type": "",
@@ -13433,7 +13433,7 @@
},
"x-appwrite": {
"method": "listCountriesPhones",
"group": "countries",
"group": null,
"weight": 121,
"cookies": false,
"type": "",
@@ -13487,7 +13487,7 @@
},
"x-appwrite": {
"method": "listCurrencies",
"group": "currencies",
"group": null,
"weight": 123,
"cookies": false,
"type": "",
@@ -13541,7 +13541,7 @@
},
"x-appwrite": {
"method": "listLanguages",
"group": "languages",
"group": null,
"weight": 124,
"cookies": false,
"type": "",
@@ -18179,7 +18179,7 @@
},
"x-appwrite": {
"method": "list",
"group": "migrations",
"group": null,
"weight": 338,
"cookies": false,
"type": "",
@@ -18252,7 +18252,7 @@
},
"x-appwrite": {
"method": "createAppwriteMigration",
"group": "appwrite",
"group": null,
"weight": 334,
"cookies": false,
"type": "",
@@ -18346,7 +18346,7 @@
},
"x-appwrite": {
"method": "getAppwriteReport",
"group": "appwrite",
"group": null,
"weight": 340,
"cookies": false,
"type": "",
@@ -18434,7 +18434,7 @@
},
"x-appwrite": {
"method": "createFirebaseMigration",
"group": "firebase",
"group": null,
"weight": 335,
"cookies": false,
"type": "",
@@ -18514,7 +18514,7 @@
},
"x-appwrite": {
"method": "getFirebaseReport",
"group": "firebase",
"group": null,
"weight": 341,
"cookies": false,
"type": "",
@@ -18585,7 +18585,7 @@
},
"x-appwrite": {
"method": "createNHostMigration",
"group": "nhost",
"group": null,
"weight": 337,
"cookies": false,
"type": "",
@@ -18706,7 +18706,7 @@
},
"x-appwrite": {
"method": "getNHostReport",
"group": "nhost",
"group": null,
"weight": 343,
"cookies": false,
"type": "",
@@ -18826,7 +18826,7 @@
},
"x-appwrite": {
"method": "createSupabaseMigration",
"group": "supabase",
"group": null,
"weight": 336,
"cookies": false,
"type": "",
@@ -18940,7 +18940,7 @@
},
"x-appwrite": {
"method": "getSupabaseReport",
"group": "supabase",
"group": null,
"weight": 342,
"cookies": false,
"type": "",
@@ -19053,7 +19053,7 @@
},
"x-appwrite": {
"method": "get",
"group": "migrations",
"group": null,
"weight": 339,
"cookies": false,
"type": "",
@@ -19111,7 +19111,7 @@
},
"x-appwrite": {
"method": "retry",
"group": "migrations",
"group": null,
"weight": 344,
"cookies": false,
"type": "",
@@ -19164,7 +19164,7 @@
},
"x-appwrite": {
"method": "delete",
"group": "migrations",
"group": null,
"weight": 345,
"cookies": false,
"type": "",
@@ -19224,7 +19224,7 @@
},
"x-appwrite": {
"method": "getUsage",
"group": "usage",
"group": null,
"weight": 196,
"cookies": false,
"type": "",
@@ -19308,7 +19308,7 @@
},
"x-appwrite": {
"method": "listVariables",
"group": "variables",
"group": null,
"weight": 198,
"cookies": false,
"type": "",
@@ -19356,7 +19356,7 @@
},
"x-appwrite": {
"method": "createVariable",
"group": "variables",
"group": null,
"weight": 197,
"cookies": false,
"type": "",
@@ -19433,7 +19433,7 @@
},
"x-appwrite": {
"method": "getVariable",
"group": "variables",
"group": null,
"weight": 199,
"cookies": false,
"type": "",
@@ -19491,7 +19491,7 @@
},
"x-appwrite": {
"method": "updateVariable",
"group": "variables",
"group": null,
"weight": 200,
"cookies": false,
"type": "",
@@ -19568,7 +19568,7 @@
},
"x-appwrite": {
"method": "deleteVariable",
"group": "variables",
"group": null,
"weight": 201,
"cookies": false,
"type": "",
@@ -24495,7 +24495,7 @@
},
"x-appwrite": {
"method": "listRules",
"group": "rules",
"group": null,
"weight": 317,
"cookies": false,
"type": "",
@@ -24566,7 +24566,7 @@
},
"x-appwrite": {
"method": "createRule",
"group": "rules",
"group": null,
"weight": 316,
"cookies": false,
"type": "",
@@ -24655,7 +24655,7 @@
},
"x-appwrite": {
"method": "getRule",
"group": "rules",
"group": null,
"weight": 318,
"cookies": false,
"type": "",
@@ -24708,7 +24708,7 @@
},
"x-appwrite": {
"method": "deleteRule",
"group": "rules",
"group": null,
"weight": 319,
"cookies": false,
"type": "",
@@ -24768,7 +24768,7 @@
},
"x-appwrite": {
"method": "updateRuleVerification",
"group": "rules",
"group": null,
"weight": 320,
"cookies": false,
"type": "",
@@ -25946,87 +25946,6 @@
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/push": {
"get": {
"summary": "Get file for push notification",
"operationId": "storageGetFilePush",
"consumes": [
"application\/json"
],
"produces": [
"*\/*"
],
"tags": [
"storage"
],
"description": "Get a file for push notification by its unique ID. This endpoint response returns a JSON object with the file metadata.",
"responses": {
"200": {
"description": "File",
"schema": {
"type": "file"
}
}
},
"x-appwrite": {
"method": "getFilePush",
"group": "files",
"weight": 213,
"cookies": false,
"type": "location",
"deprecated": false,
"demo": "storage\/get-file-push.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-push.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "public",
"platforms": [
"client",
"server",
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"type": "string",
"x-example": "<BUCKET_ID>",
"in": "path"
},
{
"name": "fileId",
"description": "File ID.",
"required": true,
"type": "string",
"x-example": "<FILE_ID>",
"in": "path"
},
{
"name": "jwt",
"description": "JSON Web Token to validate",
"required": false,
"type": "string",
"x-example": "<JWT>",
"default": "",
"in": "query"
}
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": {
"get": {
"summary": "Get file for view",
@@ -26123,7 +26042,7 @@
},
"x-appwrite": {
"method": "getUsage",
"group": "usage",
"group": null,
"weight": 216,
"cookies": false,
"type": "",
@@ -26195,7 +26114,7 @@
},
"x-appwrite": {
"method": "getBucketUsage",
"group": "usage",
"group": null,
"weight": 217,
"cookies": false,
"type": "",
@@ -28387,7 +28306,7 @@
},
"x-appwrite": {
"method": "getUsage",
"group": "usage",
"group": null,
"weight": 274,
"cookies": false,
"type": "",
+15 -98
View File
@@ -3144,7 +3144,7 @@
},
"x-appwrite": {
"method": "getBrowser",
"group": "icons",
"group": null,
"weight": 60,
"cookies": false,
"type": "location",
@@ -3273,7 +3273,7 @@
},
"x-appwrite": {
"method": "getCreditCard",
"group": "icons",
"group": null,
"weight": 59,
"cookies": false,
"type": "location",
@@ -3408,7 +3408,7 @@
},
"x-appwrite": {
"method": "getFavicon",
"group": "images",
"group": null,
"weight": 63,
"cookies": false,
"type": "location",
@@ -3475,7 +3475,7 @@
},
"x-appwrite": {
"method": "getFlag",
"group": "icons",
"group": null,
"weight": 61,
"cookies": false,
"type": "location",
@@ -3966,7 +3966,7 @@
},
"x-appwrite": {
"method": "getImage",
"group": "images",
"group": null,
"weight": 62,
"cookies": false,
"type": "location",
@@ -4053,7 +4053,7 @@
},
"x-appwrite": {
"method": "getInitials",
"group": "images",
"group": null,
"weight": 65,
"cookies": false,
"type": "location",
@@ -4148,7 +4148,7 @@
},
"x-appwrite": {
"method": "getQR",
"group": "images",
"group": null,
"weight": 64,
"cookies": false,
"type": "location",
@@ -12045,7 +12045,7 @@
},
"x-appwrite": {
"method": "get",
"group": "locale",
"group": null,
"weight": 117,
"cookies": false,
"type": "",
@@ -12101,7 +12101,7 @@
},
"x-appwrite": {
"method": "listCodes",
"group": "locale",
"group": null,
"weight": 118,
"cookies": false,
"type": "",
@@ -12157,7 +12157,7 @@
},
"x-appwrite": {
"method": "listContinents",
"group": "continents",
"group": null,
"weight": 122,
"cookies": false,
"type": "",
@@ -12213,7 +12213,7 @@
},
"x-appwrite": {
"method": "listCountries",
"group": "countries",
"group": null,
"weight": 119,
"cookies": false,
"type": "",
@@ -12269,7 +12269,7 @@
},
"x-appwrite": {
"method": "listCountriesEU",
"group": "countries",
"group": null,
"weight": 120,
"cookies": false,
"type": "",
@@ -12325,7 +12325,7 @@
},
"x-appwrite": {
"method": "listCountriesPhones",
"group": "countries",
"group": null,
"weight": 121,
"cookies": false,
"type": "",
@@ -12381,7 +12381,7 @@
},
"x-appwrite": {
"method": "listCurrencies",
"group": "currencies",
"group": null,
"weight": 123,
"cookies": false,
"type": "",
@@ -12437,7 +12437,7 @@
},
"x-appwrite": {
"method": "listLanguages",
"group": "languages",
"group": null,
"weight": 124,
"cookies": false,
"type": "",
@@ -18262,89 +18262,6 @@
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/push": {
"get": {
"summary": "Get file for push notification",
"operationId": "storageGetFilePush",
"consumes": [
"application\/json"
],
"produces": [
"*\/*"
],
"tags": [
"storage"
],
"description": "Get a file for push notification by its unique ID. This endpoint response returns a JSON object with the file metadata.",
"responses": {
"200": {
"description": "File",
"schema": {
"type": "file"
}
}
},
"x-appwrite": {
"method": "getFilePush",
"group": "files",
"weight": 213,
"cookies": false,
"type": "location",
"deprecated": false,
"demo": "storage\/get-file-push.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-push.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "public",
"platforms": [
"client",
"server",
"server"
],
"packaging": false,
"auth": {
"Project": [],
"Session": []
}
},
"security": [
{
"Project": [],
"Session": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"type": "string",
"x-example": "<BUCKET_ID>",
"in": "path"
},
{
"name": "fileId",
"description": "File ID.",
"required": true,
"type": "string",
"x-example": "<FILE_ID>",
"in": "path"
},
{
"name": "jwt",
"description": "JSON Web Token to validate",
"required": false,
"type": "string",
"x-example": "<JWT>",
"default": "",
"in": "query"
}
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": {
"get": {
"summary": "Get file for view",
+7 -7
View File
@@ -171,7 +171,7 @@ App::get('/v1/avatars/credit-cards/:code')
->label('cache.resource', 'avatar/credit-card')
->label('sdk', new Method(
namespace: 'avatars',
group: 'icons',
group: null,
name: 'getCreditCard',
description: '/docs/references/avatars/get-credit-card.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
@@ -199,7 +199,7 @@ App::get('/v1/avatars/browsers/:code')
->label('cache.resource', 'avatar/browser')
->label('sdk', new Method(
namespace: 'avatars',
group: 'icons',
group: null,
name: 'getBrowser',
description: '/docs/references/avatars/get-browser.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
@@ -227,7 +227,7 @@ App::get('/v1/avatars/flags/:code')
->label('cache.resource', 'avatar/flag')
->label('sdk', new Method(
namespace: 'avatars',
group: 'icons',
group: null,
name: 'getFlag',
description: '/docs/references/avatars/get-flag.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
@@ -255,7 +255,7 @@ App::get('/v1/avatars/image')
->label('cache.resource', 'avatar/image')
->label('sdk', new Method(
namespace: 'avatars',
group: 'images',
group: null,
name: 'getImage',
description: '/docs/references/avatars/get-image.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
@@ -326,7 +326,7 @@ App::get('/v1/avatars/favicon')
->label('cache.resource', 'avatar/favicon')
->label('sdk', new Method(
namespace: 'avatars',
group: 'images',
group: null,
name: 'getFavicon',
description: '/docs/references/avatars/get-favicon.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
@@ -477,7 +477,7 @@ App::get('/v1/avatars/qr')
->label('scope', 'avatars.read')
->label('sdk', new Method(
namespace: 'avatars',
group: 'images',
group: null,
name: 'getQR',
description: '/docs/references/avatars/get-qr.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
@@ -526,7 +526,7 @@ App::get('/v1/avatars/initials')
->label('cache.resource', 'avatar/initials')
->label('sdk', new Method(
namespace: 'avatars',
group: 'images',
group: null,
name: 'getInitials',
description: '/docs/references/avatars/get-initials.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
+3 -3
View File
@@ -4217,7 +4217,7 @@ App::get('/v1/databases/usage')
->label('resourceType', RESOURCE_TYPE_DATABASES)
->label('sdk', new Method(
namespace: 'databases',
group: 'usage',
group: null,
name: 'getUsage',
description: '/docs/references/databases/get-usage.md',
auth: [AuthType::ADMIN],
@@ -4313,7 +4313,7 @@ App::get('/v1/databases/:databaseId/usage')
->label('resourceType', RESOURCE_TYPE_DATABASES)
->label('sdk', new Method(
namespace: 'databases',
group: 'usage',
group: null,
name: 'getDatabaseUsage',
description: '/docs/references/databases/get-database-usage.md',
auth: [AuthType::ADMIN],
@@ -4415,7 +4415,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/usage')
->label('resourceType', RESOURCE_TYPE_DATABASES)
->label('sdk', new Method(
namespace: 'databases',
group: 'usage',
group: null,
name: 'getCollectionUsage',
description: '/docs/references/databases/get-collection-usage.md',
auth: [AuthType::ADMIN],
+2 -2
View File
@@ -613,7 +613,7 @@ App::get('/v1/functions/:functionId/usage')
->label('resourceType', RESOURCE_TYPE_FUNCTIONS)
->label('sdk', new Method(
namespace: 'functions',
group: 'usage',
group: null,
name: 'getFunctionUsage',
description: '/docs/references/functions/get-function-usage.md',
auth: [AuthType::ADMIN],
@@ -725,7 +725,7 @@ App::get('/v1/functions/usage')
->label('resourceType', RESOURCE_TYPE_FUNCTIONS)
->label('sdk', new Method(
namespace: 'functions',
group: 'usage',
group: null,
name: 'getUsage',
description: '/docs/references/functions/get-functions-usage.md',
auth: [AuthType::ADMIN],
+8 -8
View File
@@ -17,7 +17,7 @@ App::get('/v1/locale')
->label('scope', 'locale.read')
->label('sdk', new Method(
namespace: 'locale',
group: 'locale',
group: null,
name: 'get',
description: '/docs/references/locale/get-locale.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
@@ -81,7 +81,7 @@ App::get('/v1/locale/codes')
->label('scope', 'locale.read')
->label('sdk', new Method(
namespace: 'locale',
group: 'locale',
group: null,
name: 'listCodes',
description: '/docs/references/locale/list-locale-codes.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
@@ -107,7 +107,7 @@ App::get('/v1/locale/countries')
->label('scope', 'locale.read')
->label('sdk', new Method(
namespace: 'locale',
group: 'countries',
group: null,
name: 'listCountries',
description: '/docs/references/locale/list-countries.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
@@ -144,7 +144,7 @@ App::get('/v1/locale/countries/eu')
->label('scope', 'locale.read')
->label('sdk', new Method(
namespace: 'locale',
group: 'countries',
group: null,
name: 'listCountriesEU',
description: '/docs/references/locale/list-countries-eu.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
@@ -183,7 +183,7 @@ App::get('/v1/locale/countries/phones')
->label('scope', 'locale.read')
->label('sdk', new Method(
namespace: 'locale',
group: 'countries',
group: null,
name: 'listCountriesPhones',
description: '/docs/references/locale/list-countries-phones.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
@@ -221,7 +221,7 @@ App::get('/v1/locale/continents')
->label('scope', 'locale.read')
->label('sdk', new Method(
namespace: 'locale',
group: 'continents',
group: null,
name: 'listContinents',
description: '/docs/references/locale/list-continents.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
@@ -257,7 +257,7 @@ App::get('/v1/locale/currencies')
->label('scope', 'locale.read')
->label('sdk', new Method(
namespace: 'locale',
group: 'currencies',
group: null,
name: 'listCurrencies',
description: '/docs/references/locale/list-currencies.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
@@ -284,7 +284,7 @@ App::get('/v1/locale/languages')
->label('scope', 'locale.read')
->label('sdk', new Method(
namespace: 'locale',
group: 'languages',
group: null,
name: 'listLanguages',
description: '/docs/references/locale/list-languages.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
+12 -12
View File
@@ -37,7 +37,7 @@ App::post('/v1/migrations/appwrite')
->label('audits.event', 'migration.create')
->label('sdk', new Method(
namespace: 'migrations',
group: 'appwrite',
group: null,
name: 'createAppwriteMigration',
description: '/docs/references/migrations/migration-appwrite.md',
auth: [AuthType::ADMIN],
@@ -99,7 +99,7 @@ App::post('/v1/migrations/firebase')
->label('audits.event', 'migration.create')
->label('sdk', new Method(
namespace: 'migrations',
group: 'firebase',
group: null,
name: 'createFirebaseMigration',
description: '/docs/references/migrations/migration-firebase.md',
auth: [AuthType::ADMIN],
@@ -166,7 +166,7 @@ App::post('/v1/migrations/supabase')
->label('audits.event', 'migration.create')
->label('sdk', new Method(
namespace: 'migrations',
group: 'supabase',
group: null,
name: 'createSupabaseMigration',
description: '/docs/references/migrations/migration-supabase.md',
auth: [AuthType::ADMIN],
@@ -233,7 +233,7 @@ App::post('/v1/migrations/nhost')
->label('audits.event', 'migration.create')
->label('sdk', new Method(
namespace: 'migrations',
group: 'nhost',
group: null,
name: 'createNHostMigration',
description: '/docs/references/migrations/migration-nhost.md',
auth: [AuthType::ADMIN],
@@ -300,7 +300,7 @@ App::get('/v1/migrations')
->label('scope', 'migrations.read')
->label('sdk', new Method(
namespace: 'migrations',
group: 'migrations',
group: null,
name: 'list',
description: '/docs/references/migrations/list-migrations.md',
auth: [AuthType::ADMIN],
@@ -365,7 +365,7 @@ App::get('/v1/migrations/:migrationId')
->label('scope', 'migrations.read')
->label('sdk', new Method(
namespace: 'migrations',
group: 'migrations',
group: null,
name: 'get',
description: '/docs/references/migrations/get-migration.md',
auth: [AuthType::ADMIN],
@@ -395,7 +395,7 @@ App::get('/v1/migrations/appwrite/report')
->label('scope', 'migrations.write')
->label('sdk', new Method(
namespace: 'migrations',
group: 'appwrite',
group: null,
name: 'getAppwriteReport',
description: '/docs/references/migrations/migration-appwrite-report.md',
auth: [AuthType::ADMIN],
@@ -443,7 +443,7 @@ App::get('/v1/migrations/firebase/report')
->label('scope', 'migrations.write')
->label('sdk', new Method(
namespace: 'migrations',
group: 'firebase',
group: null,
name: 'getFirebaseReport',
description: '/docs/references/migrations/migration-firebase-report.md',
auth: [AuthType::ADMIN],
@@ -496,7 +496,7 @@ App::get('/v1/migrations/supabase/report')
->label('scope', 'migrations.write')
->label('sdk', new Method(
namespace: 'migrations',
group: 'supabase',
group: null,
name: 'getSupabaseReport',
description: '/docs/references/migrations/migration-supabase-report.md',
auth: [AuthType::ADMIN],
@@ -545,7 +545,7 @@ App::get('/v1/migrations/nhost/report')
->label('scope', 'migrations.write')
->label('sdk', new Method(
namespace: 'migrations',
group: 'nhost',
group: null,
name: 'getNHostReport',
description: '/docs/references/migrations/migration-nhost-report.md',
auth: [AuthType::ADMIN],
@@ -597,7 +597,7 @@ App::patch('/v1/migrations/:migrationId')
->label('audits.resource', 'migrations/{request.migrationId}')
->label('sdk', new Method(
namespace: 'migrations',
group: 'migrations',
group: null,
name: 'retry',
description: '/docs/references/migrations/retry-migration.md',
auth: [AuthType::ADMIN],
@@ -648,7 +648,7 @@ App::delete('/v1/migrations/:migrationId')
->label('audits.resource', 'migrations/{request.migrationId}')
->label('sdk', new Method(
namespace: 'migrations',
group: 'migrations',
group: null,
name: 'delete',
description: '/docs/references/migrations/delete-migration.md',
auth: [AuthType::ADMIN],
+6 -6
View File
@@ -26,7 +26,7 @@ App::get('/v1/project/usage')
->label('scope', 'projects.read')
->label('sdk', new Method(
namespace: 'project',
group: 'usage',
group: null,
name: 'getUsage',
description: '/docs/references/project/get-usage.md',
auth: [AuthType::ADMIN],
@@ -388,7 +388,7 @@ App::post('/v1/project/variables')
->label('audits.event', 'variable.create')
->label('sdk', new Method(
namespace: 'project',
group: 'variables',
group: null,
name: 'createVariable',
description: '/docs/references/project/create-variable.md',
auth: [AuthType::ADMIN],
@@ -448,7 +448,7 @@ App::get('/v1/project/variables')
->label('scope', 'projects.read')
->label('sdk', new Method(
namespace: 'project',
group: 'variables',
group: null,
name: 'listVariables',
description: '/docs/references/project/list-variables.md',
auth: [AuthType::ADMIN],
@@ -479,7 +479,7 @@ App::get('/v1/project/variables/:variableId')
->label('scope', 'projects.read')
->label('sdk', new Method(
namespace: 'project',
group: 'variables',
group: null,
name: 'getVariable',
description: '/docs/references/project/get-variable.md',
auth: [AuthType::ADMIN],
@@ -509,7 +509,7 @@ App::put('/v1/project/variables/:variableId')
->label('scope', 'projects.write')
->label('sdk', new Method(
namespace: 'project',
group: 'variables',
group: null,
name: 'updateVariable',
description: '/docs/references/project/update-variable.md',
auth: [AuthType::ADMIN],
@@ -561,7 +561,7 @@ App::delete('/v1/project/variables/:variableId')
->label('scope', 'projects.write')
->label('sdk', new Method(
namespace: 'project',
group: 'variables',
group: null,
name: 'deleteVariable',
description: '/docs/references/project/delete-variable.md',
auth: [AuthType::ADMIN],
+5 -5
View File
@@ -35,7 +35,7 @@ App::post('/v1/proxy/rules')
->label('audits.resource', 'rule/{response.$id}')
->label('sdk', new Method(
namespace: 'proxy',
group: 'rules',
group: null,
name: 'createRule',
description: '/docs/references/proxy/create-rule.md',
auth: [AuthType::ADMIN],
@@ -174,7 +174,7 @@ App::get('/v1/proxy/rules')
->label('scope', 'rules.read')
->label('sdk', new Method(
namespace: 'proxy',
group: 'rules',
group: null,
name: 'listRules',
description: '/docs/references/proxy/list-rules.md',
auth: [AuthType::ADMIN],
@@ -249,7 +249,7 @@ App::get('/v1/proxy/rules/:ruleId')
->label('scope', 'rules.read')
->label('sdk', new Method(
namespace: 'proxy',
group: 'rules',
group: null,
name: 'getRule',
description: '/docs/references/proxy/get-rule.md',
auth: [AuthType::ADMIN],
@@ -287,7 +287,7 @@ App::delete('/v1/proxy/rules/:ruleId')
->label('audits.resource', 'rule/{request.ruleId}')
->label('sdk', new Method(
namespace: 'proxy',
group: 'rules',
group: null,
name: 'deleteRule',
description: '/docs/references/proxy/delete-rule.md',
auth: [AuthType::ADMIN],
@@ -332,7 +332,7 @@ App::patch('/v1/proxy/rules/:ruleId/verification')
->label('audits.resource', 'rule/{response.$id}')
->label('sdk', new Method(
namespace: 'proxy',
group: 'rules',
group: null,
name: 'updateRuleVerification',
description: '/docs/references/proxy/update-rule-verification.md',
auth: [AuthType::ADMIN],
+2 -17
View File
@@ -1407,21 +1407,6 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId/push')
->groups(['api', 'storage'])
->label('scope', 'public')
->label('resourceType', RESOURCE_TYPE_BUCKETS)
->label('sdk', new Method(
namespace: 'storage',
group: 'files',
name: 'getFilePush',
description: '/docs/references/storage/get-file-push.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
responses: [
new SDKResponse(
code: Response::STATUS_CODE_OK,
model: Response::MODEL_NONE,
)
],
type: MethodType::LOCATION,
contentType: ContentType::ANY,
))
->param('bucketId', '', new UID(), 'Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).')
->param('fileId', '', new UID(), 'File ID.')
->param('jwt', '', new Text(2048, 0), 'JSON Web Token to validate', true)
@@ -1797,7 +1782,7 @@ App::get('/v1/storage/usage')
->label('resourceType', RESOURCE_TYPE_BUCKETS)
->label('sdk', new Method(
namespace: 'storage',
group: 'usage',
group: null,
name: 'getUsage',
description: '/docs/references/storage/get-usage.md',
auth: [AuthType::ADMIN],
@@ -1884,7 +1869,7 @@ App::get('/v1/storage/:bucketId/usage')
->label('resourceType', RESOURCE_TYPE_BUCKETS)
->label('sdk', new Method(
namespace: 'storage',
group: 'usage',
group: null,
name: 'getBucketUsage',
description: '/docs/references/storage/get-bucket-usage.md',
auth: [AuthType::ADMIN],
+1 -1
View File
@@ -2434,7 +2434,7 @@ App::get('/v1/users/usage')
->label('scope', 'users.read')
->label('sdk', new Method(
namespace: 'users',
group: 'usage',
group: null,
name: 'getUsage',
description: '/docs/references/users/get-usage.md',
auth: [AuthType::ADMIN],
-1
View File
@@ -1 +0,0 @@
Get a file for push notification by its unique ID. This endpoint response returns a JSON object with the file metadata.
+3 -3
View File
@@ -16,7 +16,7 @@ class Method
* Initialise a new SDK method
*
* @param string $namespace
* @param string $group
* @param string|null $group
* @param string $name
* @param string $description
* @param array<AuthType> $auth
@@ -34,7 +34,7 @@ class Method
*/
public function __construct(
protected string $namespace,
protected string $group,
protected string|null $group,
protected string $name,
protected string $description,
protected array $auth,
@@ -128,7 +128,7 @@ class Method
return $this->namespace;
}
public function getGroup(): string
public function getGroup(): string|null
{
return $this->group;
}