From ebfa6eba8b51da89917366cd8e7182b3713e0ffc Mon Sep 17 00:00:00 2001 From: Darshan Date: Mon, 23 Jun 2025 11:49:43 +0530 Subject: [PATCH] update: formatter, specs, docs, sdk method names. --- app/config/specs/open-api3-1.8.x-console.json | 40 +++++++++------- app/config/specs/open-api3-1.8.x-server.json | 8 ++-- .../specs/open-api3-latest-console.json | 40 +++++++++------- app/config/specs/open-api3-latest-server.json | 8 ++-- app/config/specs/swagger2-1.8.x-console.json | 40 +++++++++------- app/config/specs/swagger2-1.8.x-server.json | 8 ++-- app/config/specs/swagger2-latest-console.json | 40 +++++++++------- app/config/specs/swagger2-latest-server.json | 8 ++-- .../examples/databases/get-database-usage.md | 14 ++++++ .../examples/databases/get-usage.md | 1 - .../examples/databases/list-usage.md | 13 +++++ .../examples/tables/create-index.md | 4 +- .../tables/create-relationship-column.md | 6 +-- .../console-web/examples/tables/get-usage.md | 15 ++++++ .../tables/update-relationship-column.md | 4 +- docs/references/databases/get-usage.md | 1 - docs/references/databases/list-usage.md | 1 + .../Http/Databases/Tables/Usage/Get.php | 2 +- .../Databases/Http/Databases/Usage/Get.php | 4 +- .../Databases/Http/Databases/Usage/XList.php | 6 +-- src/Appwrite/SDK/Specification/Format.php | 48 +++++++++++++++---- 21 files changed, 198 insertions(+), 113 deletions(-) create mode 100644 docs/examples/1.8.x/console-web/examples/databases/get-database-usage.md create mode 100644 docs/examples/1.8.x/console-web/examples/databases/list-usage.md create mode 100644 docs/examples/1.8.x/console-web/examples/tables/get-usage.md delete mode 100644 docs/references/databases/get-usage.md create mode 100644 docs/references/databases/list-usage.md diff --git a/app/config/specs/open-api3-1.8.x-console.json b/app/config/specs/open-api3-1.8.x-console.json index 77b8b42436..74dcc1ab18 100644 --- a/app/config/specs/open-api3-1.8.x-console.json +++ b/app/config/specs/open-api3-1.8.x-console.json @@ -4674,11 +4674,11 @@ "\/databases\/usage": { "get": { "summary": "Get databases usage stats", - "operationId": "databasesListUsages", + "operationId": "databasesListUsage", "tags": [ "databases" ], - "description": "Get usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections\/tables, documents\/rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", "responses": { "200": { "description": "UsageDatabases", @@ -4692,14 +4692,14 @@ } }, "x-appwrite": { - "method": "listUsages", + "method": "listUsage", "group": null, "weight": 324, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/list-usages.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-usage.md", + "demo": "databases\/list-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -4730,8 +4730,12 @@ "30d", "90d" ], - "x-enum-name": null, - "x-enum-keys": [], + "x-enum-name": "DatabaseUsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], "default": "30d" }, "in": "query" @@ -11945,7 +11949,7 @@ "manyToMany", "oneToMany" ], - "x-enum-name": null, + "x-enum-name": "RelationshipType", "x-enum-keys": [] }, "twoWay": { @@ -11972,7 +11976,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] } }, @@ -12711,7 +12715,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] }, "newKey": { @@ -12897,7 +12901,7 @@ "fulltext", "unique" ], - "x-enum-name": null, + "x-enum-name": "IndexType", "x-enum-keys": [] }, "columns": { @@ -14436,7 +14440,7 @@ "\/databases\/{databaseId}\/tables\/{tableId}\/usage": { "get": { "summary": "Get table usage stats", - "operationId": "tablesGetTableUsage", + "operationId": "tablesGetUsage", "tags": [ "tables" ], @@ -14454,13 +14458,13 @@ } }, "x-appwrite": { - "method": "getTableUsage", + "method": "getUsage", "group": null, "weight": 377, "cookies": false, "type": "", "deprecated": false, - "demo": "tables\/get-table-usage.md", + "demo": "tables\/get-usage.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table-usage.md", "rate-limit": 0, "rate-time": 3600, @@ -14502,7 +14506,7 @@ "30d", "90d" ], - "x-enum-name": null, + "x-enum-name": "DatabaseUsageRange", "x-enum-keys": [], "default": "30d" }, @@ -14524,7 +14528,7 @@ "\/databases\/{databaseId}\/usage": { "get": { "summary": "Get database usage stats", - "operationId": "databasesGetUsage", + "operationId": "databasesGetDatabaseUsage", "tags": [ "databases" ], @@ -14542,13 +14546,13 @@ } }, "x-appwrite": { - "method": "getUsage", + "method": "getDatabaseUsage", "group": null, "weight": 323, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-usage.md", + "demo": "databases\/get-database-usage.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-database-usage.md", "rate-limit": 0, "rate-time": 3600, diff --git a/app/config/specs/open-api3-1.8.x-server.json b/app/config/specs/open-api3-1.8.x-server.json index a4e905fda7..78f3dac6d3 100644 --- a/app/config/specs/open-api3-1.8.x-server.json +++ b/app/config/specs/open-api3-1.8.x-server.json @@ -11129,7 +11129,7 @@ "manyToMany", "oneToMany" ], - "x-enum-name": null, + "x-enum-name": "RelationshipType", "x-enum-keys": [] }, "twoWay": { @@ -11156,7 +11156,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] } }, @@ -11902,7 +11902,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] }, "newKey": { @@ -12090,7 +12090,7 @@ "fulltext", "unique" ], - "x-enum-name": null, + "x-enum-name": "IndexType", "x-enum-keys": [] }, "columns": { diff --git a/app/config/specs/open-api3-latest-console.json b/app/config/specs/open-api3-latest-console.json index 77b8b42436..74dcc1ab18 100644 --- a/app/config/specs/open-api3-latest-console.json +++ b/app/config/specs/open-api3-latest-console.json @@ -4674,11 +4674,11 @@ "\/databases\/usage": { "get": { "summary": "Get databases usage stats", - "operationId": "databasesListUsages", + "operationId": "databasesListUsage", "tags": [ "databases" ], - "description": "Get usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections\/tables, documents\/rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", "responses": { "200": { "description": "UsageDatabases", @@ -4692,14 +4692,14 @@ } }, "x-appwrite": { - "method": "listUsages", + "method": "listUsage", "group": null, "weight": 324, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/list-usages.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-usage.md", + "demo": "databases\/list-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -4730,8 +4730,12 @@ "30d", "90d" ], - "x-enum-name": null, - "x-enum-keys": [], + "x-enum-name": "DatabaseUsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], "default": "30d" }, "in": "query" @@ -11945,7 +11949,7 @@ "manyToMany", "oneToMany" ], - "x-enum-name": null, + "x-enum-name": "RelationshipType", "x-enum-keys": [] }, "twoWay": { @@ -11972,7 +11976,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] } }, @@ -12711,7 +12715,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] }, "newKey": { @@ -12897,7 +12901,7 @@ "fulltext", "unique" ], - "x-enum-name": null, + "x-enum-name": "IndexType", "x-enum-keys": [] }, "columns": { @@ -14436,7 +14440,7 @@ "\/databases\/{databaseId}\/tables\/{tableId}\/usage": { "get": { "summary": "Get table usage stats", - "operationId": "tablesGetTableUsage", + "operationId": "tablesGetUsage", "tags": [ "tables" ], @@ -14454,13 +14458,13 @@ } }, "x-appwrite": { - "method": "getTableUsage", + "method": "getUsage", "group": null, "weight": 377, "cookies": false, "type": "", "deprecated": false, - "demo": "tables\/get-table-usage.md", + "demo": "tables\/get-usage.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table-usage.md", "rate-limit": 0, "rate-time": 3600, @@ -14502,7 +14506,7 @@ "30d", "90d" ], - "x-enum-name": null, + "x-enum-name": "DatabaseUsageRange", "x-enum-keys": [], "default": "30d" }, @@ -14524,7 +14528,7 @@ "\/databases\/{databaseId}\/usage": { "get": { "summary": "Get database usage stats", - "operationId": "databasesGetUsage", + "operationId": "databasesGetDatabaseUsage", "tags": [ "databases" ], @@ -14542,13 +14546,13 @@ } }, "x-appwrite": { - "method": "getUsage", + "method": "getDatabaseUsage", "group": null, "weight": 323, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-usage.md", + "demo": "databases\/get-database-usage.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-database-usage.md", "rate-limit": 0, "rate-time": 3600, diff --git a/app/config/specs/open-api3-latest-server.json b/app/config/specs/open-api3-latest-server.json index a4e905fda7..78f3dac6d3 100644 --- a/app/config/specs/open-api3-latest-server.json +++ b/app/config/specs/open-api3-latest-server.json @@ -11129,7 +11129,7 @@ "manyToMany", "oneToMany" ], - "x-enum-name": null, + "x-enum-name": "RelationshipType", "x-enum-keys": [] }, "twoWay": { @@ -11156,7 +11156,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] } }, @@ -11902,7 +11902,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] }, "newKey": { @@ -12090,7 +12090,7 @@ "fulltext", "unique" ], - "x-enum-name": null, + "x-enum-name": "IndexType", "x-enum-keys": [] }, "columns": { diff --git a/app/config/specs/swagger2-1.8.x-console.json b/app/config/specs/swagger2-1.8.x-console.json index 4ac2c7b317..3599ff8712 100644 --- a/app/config/specs/swagger2-1.8.x-console.json +++ b/app/config/specs/swagger2-1.8.x-console.json @@ -4843,7 +4843,7 @@ "\/databases\/usage": { "get": { "summary": "Get databases usage stats", - "operationId": "databasesListUsages", + "operationId": "databasesListUsage", "consumes": [], "produces": [ "application\/json" @@ -4851,7 +4851,7 @@ "tags": [ "databases" ], - "description": "Get usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections\/tables, documents\/rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", "responses": { "200": { "description": "UsageDatabases", @@ -4861,14 +4861,14 @@ } }, "x-appwrite": { - "method": "listUsages", + "method": "listUsage", "group": null, "weight": 324, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/list-usages.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-usage.md", + "demo": "databases\/list-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -4898,8 +4898,12 @@ "30d", "90d" ], - "x-enum-name": null, - "x-enum-keys": [], + "x-enum-name": "DatabaseUsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], "default": "30d", "in": "query" } @@ -11979,7 +11983,7 @@ "manyToMany", "oneToMany" ], - "x-enum-name": null, + "x-enum-name": "RelationshipType", "x-enum-keys": [] }, "twoWay": { @@ -12010,7 +12014,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] } }, @@ -12733,7 +12737,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] }, "newKey": { @@ -12913,7 +12917,7 @@ "fulltext", "unique" ], - "x-enum-name": null, + "x-enum-name": "IndexType", "x-enum-keys": [] }, "columns": { @@ -14392,7 +14396,7 @@ "\/databases\/{databaseId}\/tables\/{tableId}\/usage": { "get": { "summary": "Get table usage stats", - "operationId": "tablesGetTableUsage", + "operationId": "tablesGetUsage", "consumes": [], "produces": [ "application\/json" @@ -14410,13 +14414,13 @@ } }, "x-appwrite": { - "method": "getTableUsage", + "method": "getUsage", "group": null, "weight": 377, "cookies": false, "type": "", "deprecated": false, - "demo": "tables\/get-table-usage.md", + "demo": "tables\/get-usage.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table-usage.md", "rate-limit": 0, "rate-time": 3600, @@ -14455,7 +14459,7 @@ "30d", "90d" ], - "x-enum-name": null, + "x-enum-name": "DatabaseUsageRange", "x-enum-keys": [], "default": "30d", "in": "query" @@ -14474,7 +14478,7 @@ "\/databases\/{databaseId}\/usage": { "get": { "summary": "Get database usage stats", - "operationId": "databasesGetUsage", + "operationId": "databasesGetDatabaseUsage", "consumes": [], "produces": [ "application\/json" @@ -14492,13 +14496,13 @@ } }, "x-appwrite": { - "method": "getUsage", + "method": "getDatabaseUsage", "group": null, "weight": 323, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-usage.md", + "demo": "databases\/get-database-usage.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-database-usage.md", "rate-limit": 0, "rate-time": 3600, diff --git a/app/config/specs/swagger2-1.8.x-server.json b/app/config/specs/swagger2-1.8.x-server.json index 215735cdb9..31629e6018 100644 --- a/app/config/specs/swagger2-1.8.x-server.json +++ b/app/config/specs/swagger2-1.8.x-server.json @@ -11174,7 +11174,7 @@ "manyToMany", "oneToMany" ], - "x-enum-name": null, + "x-enum-name": "RelationshipType", "x-enum-keys": [] }, "twoWay": { @@ -11205,7 +11205,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] } }, @@ -11935,7 +11935,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] }, "newKey": { @@ -12117,7 +12117,7 @@ "fulltext", "unique" ], - "x-enum-name": null, + "x-enum-name": "IndexType", "x-enum-keys": [] }, "columns": { diff --git a/app/config/specs/swagger2-latest-console.json b/app/config/specs/swagger2-latest-console.json index 4ac2c7b317..3599ff8712 100644 --- a/app/config/specs/swagger2-latest-console.json +++ b/app/config/specs/swagger2-latest-console.json @@ -4843,7 +4843,7 @@ "\/databases\/usage": { "get": { "summary": "Get databases usage stats", - "operationId": "databasesListUsages", + "operationId": "databasesListUsage", "consumes": [], "produces": [ "application\/json" @@ -4851,7 +4851,7 @@ "tags": [ "databases" ], - "description": "Get usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections\/tables, documents\/rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", "responses": { "200": { "description": "UsageDatabases", @@ -4861,14 +4861,14 @@ } }, "x-appwrite": { - "method": "listUsages", + "method": "listUsage", "group": null, "weight": 324, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/list-usages.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-usage.md", + "demo": "databases\/list-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -4898,8 +4898,12 @@ "30d", "90d" ], - "x-enum-name": null, - "x-enum-keys": [], + "x-enum-name": "DatabaseUsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], "default": "30d", "in": "query" } @@ -11979,7 +11983,7 @@ "manyToMany", "oneToMany" ], - "x-enum-name": null, + "x-enum-name": "RelationshipType", "x-enum-keys": [] }, "twoWay": { @@ -12010,7 +12014,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] } }, @@ -12733,7 +12737,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] }, "newKey": { @@ -12913,7 +12917,7 @@ "fulltext", "unique" ], - "x-enum-name": null, + "x-enum-name": "IndexType", "x-enum-keys": [] }, "columns": { @@ -14392,7 +14396,7 @@ "\/databases\/{databaseId}\/tables\/{tableId}\/usage": { "get": { "summary": "Get table usage stats", - "operationId": "tablesGetTableUsage", + "operationId": "tablesGetUsage", "consumes": [], "produces": [ "application\/json" @@ -14410,13 +14414,13 @@ } }, "x-appwrite": { - "method": "getTableUsage", + "method": "getUsage", "group": null, "weight": 377, "cookies": false, "type": "", "deprecated": false, - "demo": "tables\/get-table-usage.md", + "demo": "tables\/get-usage.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table-usage.md", "rate-limit": 0, "rate-time": 3600, @@ -14455,7 +14459,7 @@ "30d", "90d" ], - "x-enum-name": null, + "x-enum-name": "DatabaseUsageRange", "x-enum-keys": [], "default": "30d", "in": "query" @@ -14474,7 +14478,7 @@ "\/databases\/{databaseId}\/usage": { "get": { "summary": "Get database usage stats", - "operationId": "databasesGetUsage", + "operationId": "databasesGetDatabaseUsage", "consumes": [], "produces": [ "application\/json" @@ -14492,13 +14496,13 @@ } }, "x-appwrite": { - "method": "getUsage", + "method": "getDatabaseUsage", "group": null, "weight": 323, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-usage.md", + "demo": "databases\/get-database-usage.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-database-usage.md", "rate-limit": 0, "rate-time": 3600, diff --git a/app/config/specs/swagger2-latest-server.json b/app/config/specs/swagger2-latest-server.json index 215735cdb9..31629e6018 100644 --- a/app/config/specs/swagger2-latest-server.json +++ b/app/config/specs/swagger2-latest-server.json @@ -11174,7 +11174,7 @@ "manyToMany", "oneToMany" ], - "x-enum-name": null, + "x-enum-name": "RelationshipType", "x-enum-keys": [] }, "twoWay": { @@ -11205,7 +11205,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] } }, @@ -11935,7 +11935,7 @@ "restrict", "setNull" ], - "x-enum-name": null, + "x-enum-name": "RelationMutate", "x-enum-keys": [] }, "newKey": { @@ -12117,7 +12117,7 @@ "fulltext", "unique" ], - "x-enum-name": null, + "x-enum-name": "IndexType", "x-enum-keys": [] }, "columns": { diff --git a/docs/examples/1.8.x/console-web/examples/databases/get-database-usage.md b/docs/examples/1.8.x/console-web/examples/databases/get-database-usage.md new file mode 100644 index 0000000000..13038ab755 --- /dev/null +++ b/docs/examples/1.8.x/console-web/examples/databases/get-database-usage.md @@ -0,0 +1,14 @@ +import { Client, Databases, DatabaseUsageRange } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const databases = new Databases(client); + +const result = await databases.getDatabaseUsage( + '', // databaseId + DatabaseUsageRange.TwentyFourHours // range (optional) +); + +console.log(result); diff --git a/docs/examples/1.8.x/console-web/examples/databases/get-usage.md b/docs/examples/1.8.x/console-web/examples/databases/get-usage.md index b02b0687b2..a0dd3ce983 100644 --- a/docs/examples/1.8.x/console-web/examples/databases/get-usage.md +++ b/docs/examples/1.8.x/console-web/examples/databases/get-usage.md @@ -7,7 +7,6 @@ const client = new Client() const databases = new Databases(client); const result = await databases.getUsage( - '', // databaseId DatabaseUsageRange.TwentyFourHours // range (optional) ); diff --git a/docs/examples/1.8.x/console-web/examples/databases/list-usage.md b/docs/examples/1.8.x/console-web/examples/databases/list-usage.md new file mode 100644 index 0000000000..1be9949a84 --- /dev/null +++ b/docs/examples/1.8.x/console-web/examples/databases/list-usage.md @@ -0,0 +1,13 @@ +import { Client, Databases, DatabaseUsageRange } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const databases = new Databases(client); + +const result = await databases.listUsage( + DatabaseUsageRange.TwentyFourHours // range (optional) +); + +console.log(result); diff --git a/docs/examples/1.8.x/console-web/examples/tables/create-index.md b/docs/examples/1.8.x/console-web/examples/tables/create-index.md index b24575b6c5..c303dd289d 100644 --- a/docs/examples/1.8.x/console-web/examples/tables/create-index.md +++ b/docs/examples/1.8.x/console-web/examples/tables/create-index.md @@ -1,4 +1,4 @@ -import { Client, Tables, } from "@appwrite.io/console"; +import { Client, Tables, IndexType } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -10,7 +10,7 @@ const result = await tables.createIndex( '', // databaseId '', // tableId '', // key - .Key, // type + IndexType.Key, // type [], // columns [], // orders (optional) [] // lengths (optional) diff --git a/docs/examples/1.8.x/console-web/examples/tables/create-relationship-column.md b/docs/examples/1.8.x/console-web/examples/tables/create-relationship-column.md index e6a27d6747..5658eec690 100644 --- a/docs/examples/1.8.x/console-web/examples/tables/create-relationship-column.md +++ b/docs/examples/1.8.x/console-web/examples/tables/create-relationship-column.md @@ -1,4 +1,4 @@ -import { Client, Tables, , } from "@appwrite.io/console"; +import { Client, Tables, RelationshipType, RelationMutate } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -10,11 +10,11 @@ const result = await tables.createRelationshipColumn( '', // databaseId '', // tableId '', // relatedTableId - .OneToOne, // type + RelationshipType.OneToOne, // type false, // twoWay (optional) '', // key (optional) '', // twoWayKey (optional) - .Cascade // onDelete (optional) + RelationMutate.Cascade // onDelete (optional) ); console.log(result); diff --git a/docs/examples/1.8.x/console-web/examples/tables/get-usage.md b/docs/examples/1.8.x/console-web/examples/tables/get-usage.md new file mode 100644 index 0000000000..914f11b7e2 --- /dev/null +++ b/docs/examples/1.8.x/console-web/examples/tables/get-usage.md @@ -0,0 +1,15 @@ +import { Client, Tables, DatabaseUsageRange } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const tables = new Tables(client); + +const result = await tables.getUsage( + '', // databaseId + '', // tableId + DatabaseUsageRange.24h // range (optional) +); + +console.log(result); diff --git a/docs/examples/1.8.x/console-web/examples/tables/update-relationship-column.md b/docs/examples/1.8.x/console-web/examples/tables/update-relationship-column.md index 1847e3459e..192eac7175 100644 --- a/docs/examples/1.8.x/console-web/examples/tables/update-relationship-column.md +++ b/docs/examples/1.8.x/console-web/examples/tables/update-relationship-column.md @@ -1,4 +1,4 @@ -import { Client, Tables, } from "@appwrite.io/console"; +import { Client, Tables, RelationMutate } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -10,7 +10,7 @@ const result = await tables.updateRelationshipColumn( '', // databaseId '', // tableId '', // key - .Cascade, // onDelete (optional) + RelationMutate.Cascade, // onDelete (optional) '' // newKey (optional) ); diff --git a/docs/references/databases/get-usage.md b/docs/references/databases/get-usage.md deleted file mode 100644 index d41f8704c8..0000000000 --- a/docs/references/databases/get-usage.md +++ /dev/null @@ -1 +0,0 @@ -Get usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days. \ No newline at end of file diff --git a/docs/references/databases/list-usage.md b/docs/references/databases/list-usage.md new file mode 100644 index 0000000000..0f318d6466 --- /dev/null +++ b/docs/references/databases/list-usage.md @@ -0,0 +1 @@ +List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections/tables, documents/rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days. \ No newline at end of file diff --git a/src/Appwrite/Platform/Modules/Databases/Http/Databases/Tables/Usage/Get.php b/src/Appwrite/Platform/Modules/Databases/Http/Databases/Tables/Usage/Get.php index 99146d1dd0..78ff05f5fb 100644 --- a/src/Appwrite/Platform/Modules/Databases/Http/Databases/Tables/Usage/Get.php +++ b/src/Appwrite/Platform/Modules/Databases/Http/Databases/Tables/Usage/Get.php @@ -36,7 +36,7 @@ class Get extends CollectionUsageGet ->label('sdk', new Method( namespace: $this->getSdkNamespace(), group: null, - name: self::getName(), + name: 'getUsage', // getName needs to be different from parent action to avoid conflict in path name description: '/docs/references/databases/get-table-usage.md', auth: [AuthType::ADMIN], responses: [ diff --git a/src/Appwrite/Platform/Modules/Databases/Http/Databases/Usage/Get.php b/src/Appwrite/Platform/Modules/Databases/Http/Databases/Usage/Get.php index 5482d25269..56fcc29688 100644 --- a/src/Appwrite/Platform/Modules/Databases/Http/Databases/Usage/Get.php +++ b/src/Appwrite/Platform/Modules/Databases/Http/Databases/Usage/Get.php @@ -22,7 +22,7 @@ class Get extends Action { public static function getName(): string { - return 'getUsage'; + return 'getDatabaseUsage'; } public function __construct() @@ -37,7 +37,7 @@ class Get extends Action ->label('sdk', new Method( namespace: 'databases', group: null, - name: 'getUsage', + name: self::getName(), description: '/docs/references/databases/get-database-usage.md', auth: [AuthType::ADMIN], responses: [ diff --git a/src/Appwrite/Platform/Modules/Databases/Http/Databases/Usage/XList.php b/src/Appwrite/Platform/Modules/Databases/Http/Databases/Usage/XList.php index fd3a95cd24..b5c898fd1b 100644 --- a/src/Appwrite/Platform/Modules/Databases/Http/Databases/Usage/XList.php +++ b/src/Appwrite/Platform/Modules/Databases/Http/Databases/Usage/XList.php @@ -20,7 +20,7 @@ class XList extends Action { public static function getName(): string { - return 'listUsages'; + return 'listUsage'; } public function __construct() @@ -35,8 +35,8 @@ class XList extends Action ->label('sdk', new Method( namespace: 'databases', group: null, - name: 'listUsages', - description: '/docs/references/databases/get-usage.md', + name: self::getName(), + description: '/docs/references/databases/list-usage.md', auth: [AuthType::ADMIN], responses: [ new SDKResponse( diff --git a/src/Appwrite/SDK/Specification/Format.php b/src/Appwrite/SDK/Specification/Format.php index af3b5c017e..6fa104457c 100644 --- a/src/Appwrite/SDK/Specification/Format.php +++ b/src/Appwrite/SDK/Specification/Format.php @@ -172,7 +172,8 @@ abstract class Format break; case 'databases': switch ($method) { - case 'getUsage': + /*case 'getUsage':*/ + case 'listUsage': case 'getCollectionUsage': case 'getDatabaseUsage': switch ($param) { @@ -203,6 +204,37 @@ abstract class Format } } break; + case 'tables': + switch ($method) { + case 'getUsage': + switch ($param) { + case 'range': + return 'DatabaseUsageRange'; + } + break; + case 'createRelationshipColumn': + switch ($param) { + case 'type': + return 'RelationshipType'; + case 'onDelete': + return 'RelationMutate'; + } + break; + case 'updateRelationshipColumn': + switch ($param) { + case 'onDelete': + return 'RelationMutate'; + } + break; + case 'createIndex': + switch ($param) { + case 'type': + return 'IndexType'; + case 'orders': + return 'OrderBy'; + } + } + break; case 'functions': switch ($method) { case 'getUsage': @@ -413,6 +445,7 @@ abstract class Format } return null; } + public function getEnumKeys(string $service, string $method, string $param): array { $values = []; @@ -441,7 +474,9 @@ abstract class Format break; case 'databases': switch ($method) { - case 'getUsage': + /*case 'getUsage':*/ + case 'listUsage': + case 'getTableUsage': case 'getCollectionUsage': case 'getDatabaseUsage': // Range Enum Keys @@ -460,15 +495,8 @@ abstract class Format break; } break; - case 'functions': - switch ($method) { - case 'getUsage': - case 'listUsage': - // Range Enum Keys - return ['Twenty Four Hours', 'Thirty Days', 'Ninety Days']; - } - break; case 'sites': + case 'functions': switch ($method) { case 'getUsage': case 'listUsage':