Appwrite/appwrite
1
0
Fork 0
mirror of https://github.com/appwrite/appwrite.git synced 2026-05-26 13:51:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Specs

Browse Source
This commit is contained in:
Jake Barnby
2025-08-20 18:17:27 +12:00
parent bf6e97b950
commit 800cab185b
8 changed files with 40 additions and 232 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/config/specs/open-api3-1.8.x-console.json
+7 -30
View File
@@ -4675,8 +4675,7 @@
"parameters": [
"databaseId",
"name",
"enabled",
"type"
"enabled"
],
"required": [
"databaseId",
@@ -4726,17 +4725,6 @@
"type": "boolean",
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -4756,7 +4744,7 @@
"tags": [
"databases"
],
"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.",
"description": "List 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.",
"responses": {
"200": {
"description": "UsageDatabases",
@@ -4808,7 +4796,7 @@
"model": "#\/components\/schemas\/usageDatabases"
}
],
"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.",
"description": "List 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.",
"demo": "databases\/list-usage.md",
"deprecated": {
"since": "1.8.0",
@@ -30635,17 +30623,6 @@
"type": "boolean",
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -33913,7 +33890,7 @@
"tags": [
"tablesDb"
],
"description": "List indexes in the collection.",
"description": "List indexes on the table.",
"responses": {
"200": {
"description": "Column Indexes List",
@@ -33995,7 +33972,7 @@
"tags": [
"tablesDb"
],
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.",
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.",
"responses": {
"202": {
"description": "Index",
@@ -35736,7 +35713,7 @@
"tags": [
"tablesDb"
],
"description": "Get usage metrics and statistics for a database. You can view the total number of 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": "Get usage metrics and statistics for a database. You can view the total number of tables, 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": "UsageDatabase",
@@ -35787,7 +35764,7 @@
"model": "#\/components\/schemas\/usageDatabase"
}
],
"description": "Get usage metrics and statistics for a database. You can view the total number of 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": "Get usage metrics and statistics for a database. You can view the total number of tables, 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.",
"demo": "tables-db\/get-usage.md"
}
],
app/config/specs/open-api3-1.8.x-server.json
+3 -26
View File
@@ -4196,8 +4196,7 @@
"parameters": [
"databaseId",
"name",
"enabled",
"type"
"enabled"
],
"required": [
"databaseId",
@@ -4248,17 +4247,6 @@
"type": "boolean",
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -21564,17 +21552,6 @@
"type": "boolean",
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -24779,7 +24756,7 @@
"tags": [
"tablesDb"
],
"description": "List indexes in the collection.",
"description": "List indexes on the table.",
"responses": {
"200": {
"description": "Column Indexes List",
@@ -24862,7 +24839,7 @@
"tags": [
"tablesDb"
],
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.",
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.",
"responses": {
"202": {
"description": "Index",
app/config/specs/open-api3-latest-console.json
+7 -30
View File
@@ -4675,8 +4675,7 @@
"parameters": [
"databaseId",
"name",
"enabled",
"type"
"enabled"
],
"required": [
"databaseId",
@@ -4726,17 +4725,6 @@
"type": "boolean",
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -4756,7 +4744,7 @@
"tags": [
"databases"
],
"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.",
"description": "List 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.",
"responses": {
"200": {
"description": "UsageDatabases",
@@ -4808,7 +4796,7 @@
"model": "#\/components\/schemas\/usageDatabases"
}
],
"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.",
"description": "List 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.",
"demo": "databases\/list-usage.md",
"deprecated": {
"since": "1.8.0",
@@ -30635,17 +30623,6 @@
"type": "boolean",
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -33913,7 +33890,7 @@
"tags": [
"tablesDb"
],
"description": "List indexes in the collection.",
"description": "List indexes on the table.",
"responses": {
"200": {
"description": "Column Indexes List",
@@ -33995,7 +33972,7 @@
"tags": [
"tablesDb"
],
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.",
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.",
"responses": {
"202": {
"description": "Index",
@@ -35736,7 +35713,7 @@
"tags": [
"tablesDb"
],
"description": "Get usage metrics and statistics for a database. You can view the total number of 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": "Get usage metrics and statistics for a database. You can view the total number of tables, 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": "UsageDatabase",
@@ -35787,7 +35764,7 @@
"model": "#\/components\/schemas\/usageDatabase"
}
],
"description": "Get usage metrics and statistics for a database. You can view the total number of 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": "Get usage metrics and statistics for a database. You can view the total number of tables, 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.",
"demo": "tables-db\/get-usage.md"
}
],
app/config/specs/open-api3-latest-server.json
+3 -26
View File
@@ -4196,8 +4196,7 @@
"parameters": [
"databaseId",
"name",
"enabled",
"type"
"enabled"
],
"required": [
"databaseId",
@@ -4248,17 +4247,6 @@
"type": "boolean",
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -21564,17 +21552,6 @@
"type": "boolean",
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -24779,7 +24756,7 @@
"tags": [
"tablesDb"
],
"description": "List indexes in the collection.",
"description": "List indexes on the table.",
"responses": {
"200": {
"description": "Column Indexes List",
@@ -24862,7 +24839,7 @@
"tags": [
"tablesDb"
],
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.",
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.",
"responses": {
"202": {
"description": "Index",
app/config/specs/swagger2-1.8.x-console.json
+7 -32
View File
@@ -4834,8 +4834,7 @@
"parameters": [
"databaseId",
"name",
"enabled",
"type"
"enabled"
],
"required": [
"databaseId",
@@ -4889,18 +4888,6 @@
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"default": true,
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"default": "tablesdb",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -4923,7 +4910,7 @@
"tags": [
"databases"
],
"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.",
"description": "List 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.",
"responses": {
"200": {
"description": "UsageDatabases",
@@ -4971,7 +4958,7 @@
"model": "#\/definitions\/usageDatabases"
}
],
"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.",
"description": "List 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.",
"demo": "databases\/list-usage.md",
"deprecated": {
"since": "1.8.0",
@@ -30823,18 +30810,6 @@
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"default": true,
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"default": "tablesdb",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -34068,7 +34043,7 @@
"tags": [
"tablesDb"
],
"description": "List indexes in the collection.",
"description": "List indexes on the table.",
"responses": {
"200": {
"description": "Column Indexes List",
@@ -34147,7 +34122,7 @@
"tags": [
"tablesDb"
],
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.",
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.",
"responses": {
"202": {
"description": "Index",
@@ -35813,7 +35788,7 @@
"tags": [
"tablesDb"
],
"description": "Get usage metrics and statistics for a database. You can view the total number of 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": "Get usage metrics and statistics for a database. You can view the total number of tables, 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": "UsageDatabase",
@@ -35860,7 +35835,7 @@
"model": "#\/definitions\/usageDatabase"
}
],
"description": "Get usage metrics and statistics for a database. You can view the total number of 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": "Get usage metrics and statistics for a database. You can view the total number of tables, 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.",
"demo": "tables-db\/get-usage.md"
}
],
app/config/specs/swagger2-1.8.x-server.json
+3 -28
View File
@@ -4343,8 +4343,7 @@
"parameters": [
"databaseId",
"name",
"enabled",
"type"
"enabled"
],
"required": [
"databaseId",
@@ -4399,18 +4398,6 @@
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"default": true,
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"default": "tablesdb",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -21805,18 +21792,6 @@
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"default": true,
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"default": "tablesdb",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -24989,7 +24964,7 @@
"tags": [
"tablesDb"
],
"description": "List indexes in the collection.",
"description": "List indexes on the table.",
"responses": {
"200": {
"description": "Column Indexes List",
@@ -25069,7 +25044,7 @@
"tags": [
"tablesDb"
],
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.",
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.",
"responses": {
"202": {
"description": "Index",
app/config/specs/swagger2-latest-console.json
+7 -32
View File
@@ -4834,8 +4834,7 @@
"parameters": [
"databaseId",
"name",
"enabled",
"type"
"enabled"
],
"required": [
"databaseId",
@@ -4889,18 +4888,6 @@
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"default": true,
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"default": "tablesdb",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -4923,7 +4910,7 @@
"tags": [
"databases"
],
"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.",
"description": "List 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.",
"responses": {
"200": {
"description": "UsageDatabases",
@@ -4971,7 +4958,7 @@
"model": "#\/definitions\/usageDatabases"
}
],
"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.",
"description": "List 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.",
"demo": "databases\/list-usage.md",
"deprecated": {
"since": "1.8.0",
@@ -30823,18 +30810,6 @@
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"default": true,
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"default": "tablesdb",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -34068,7 +34043,7 @@
"tags": [
"tablesDb"
],
"description": "List indexes in the collection.",
"description": "List indexes on the table.",
"responses": {
"200": {
"description": "Column Indexes List",
@@ -34147,7 +34122,7 @@
"tags": [
"tablesDb"
],
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.",
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.",
"responses": {
"202": {
"description": "Index",
@@ -35813,7 +35788,7 @@
"tags": [
"tablesDb"
],
"description": "Get usage metrics and statistics for a database. You can view the total number of 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": "Get usage metrics and statistics for a database. You can view the total number of tables, 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": "UsageDatabase",
@@ -35860,7 +35835,7 @@
"model": "#\/definitions\/usageDatabase"
}
],
"description": "Get usage metrics and statistics for a database. You can view the total number of 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": "Get usage metrics and statistics for a database. You can view the total number of tables, 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.",
"demo": "tables-db\/get-usage.md"
}
],
app/config/specs/swagger2-latest-server.json
+3 -28
View File
@@ -4343,8 +4343,7 @@
"parameters": [
"databaseId",
"name",
"enabled",
"type"
"enabled"
],
"required": [
"databaseId",
@@ -4399,18 +4398,6 @@
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"default": true,
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"default": "tablesdb",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -21805,18 +21792,6 @@
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"default": true,
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"default": "tablesdb",
"x-example": "tablesdb",
"enum": [
"tablesdb",
"legacy"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"required": [
@@ -24989,7 +24964,7 @@
"tags": [
"tablesDb"
],
"description": "List indexes in the collection.",
"description": "List indexes on the table.",
"responses": {
"200": {
"description": "Column Indexes List",
@@ -25069,7 +25044,7 @@
"tags": [
"tablesDb"
],
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.",
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.",
"responses": {
"202": {
"description": "Index",