diff --git a/examples/1.9.x/console-web/examples/apps/create.md b/examples/1.9.x/console-web/examples/apps/create.md index 05f6ad6eb..c59f6fb6d 100644 --- a/examples/1.9.x/console-web/examples/apps/create.md +++ b/examples/1.9.x/console-web/examples/apps/create.md @@ -11,6 +11,12 @@ const result = await apps.create({ appId: '', name: '', redirectUris: [], + description: '', // optional + clientUri: 'https://example.com', // optional + logoUri: 'https://example.com', // optional + privacyPolicyUrl: 'https://example.com', // optional + termsUrl: 'https://example.com', // optional + contacts: [], // optional enabled: false, // optional type: 'public', // optional deviceFlow: false, // optional diff --git a/examples/1.9.x/console-web/examples/apps/update.md b/examples/1.9.x/console-web/examples/apps/update.md index 41c377ead..4d1b12fb6 100644 --- a/examples/1.9.x/console-web/examples/apps/update.md +++ b/examples/1.9.x/console-web/examples/apps/update.md @@ -10,6 +10,12 @@ const apps = new Apps(client); const result = await apps.update({ appId: '', name: '', + description: '', // optional + clientUri: 'https://example.com', // optional + logoUri: 'https://example.com', // optional + privacyPolicyUrl: 'https://example.com', // optional + termsUrl: 'https://example.com', // optional + contacts: [], // optional enabled: false, // optional redirectUris: [], // optional type: 'public', // optional diff --git a/examples/1.9.x/console-web/examples/compute/create-database.md b/examples/1.9.x/console-web/examples/compute/create-database.md index d3738db26..294f7c588 100644 --- a/examples/1.9.x/console-web/examples/compute/create-database.md +++ b/examples/1.9.x/console-web/examples/compute/create-database.md @@ -38,7 +38,8 @@ const result = await compute.createDatabase({ storageAutoscalingThresholdPercent: 50, // optional storageAutoscalingMaxGb: 0, // optional metricsEnabled: false, // optional - poolerEnabled: false // optional + poolerEnabled: false, // optional + api: 'compute' // optional }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/documentsdb/create.md b/examples/1.9.x/console-web/examples/documentsdb/create.md index 5d73221aa..dbe140086 100644 --- a/examples/1.9.x/console-web/examples/documentsdb/create.md +++ b/examples/1.9.x/console-web/examples/documentsdb/create.md @@ -11,7 +11,7 @@ const result = await documentsDB.create({ databaseId: '', name: '', enabled: false, // optional - specification: '' // optional + dedicatedDatabaseId: '' // optional }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/tablesdb/create.md b/examples/1.9.x/console-web/examples/tablesdb/create.md index d64f39634..2f33a89f0 100644 --- a/examples/1.9.x/console-web/examples/tablesdb/create.md +++ b/examples/1.9.x/console-web/examples/tablesdb/create.md @@ -10,7 +10,8 @@ const tablesDB = new TablesDB(client); const result = await tablesDB.create({ databaseId: '', name: '', - enabled: false // optional + enabled: false, // optional + dedicatedDatabaseId: '' // optional }); console.log(result); diff --git a/examples/1.9.x/console-web/examples/vectorsdb/create.md b/examples/1.9.x/console-web/examples/vectorsdb/create.md index 73dd7149c..10d3b15b1 100644 --- a/examples/1.9.x/console-web/examples/vectorsdb/create.md +++ b/examples/1.9.x/console-web/examples/vectorsdb/create.md @@ -11,7 +11,7 @@ const result = await vectorsDB.create({ databaseId: '', name: '', enabled: false, // optional - specification: '' // optional + dedicatedDatabaseId: '' // optional }); console.log(result); diff --git a/examples/1.9.x/server-dart/examples/tablesdb/create.md b/examples/1.9.x/server-dart/examples/tablesdb/create.md index 3c85e98f5..38accc2f5 100644 --- a/examples/1.9.x/server-dart/examples/tablesdb/create.md +++ b/examples/1.9.x/server-dart/examples/tablesdb/create.md @@ -12,5 +12,6 @@ Database result = await tablesDB.create( databaseId: '', name: '', enabled: false, // (optional) + dedicatedDatabaseId: '', // (optional) ); ``` diff --git a/examples/1.9.x/server-dotnet/examples/tablesdb/create.md b/examples/1.9.x/server-dotnet/examples/tablesdb/create.md index d34245c84..07fe6cf5b 100644 --- a/examples/1.9.x/server-dotnet/examples/tablesdb/create.md +++ b/examples/1.9.x/server-dotnet/examples/tablesdb/create.md @@ -13,5 +13,6 @@ TablesDB tablesDB = new TablesDB(client); Database result = await tablesDB.Create( databaseId: "", name: "", - enabled: false // optional + enabled: false, // optional + dedicatedDatabaseId: "" // optional );``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/create.md b/examples/1.9.x/server-go/examples/tablesdb/create.md index c44f118ae..95503cc5b 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create.md @@ -19,5 +19,6 @@ response, error := service.Create( "", "", tablesdb.WithCreateEnabled(false), + tablesdb.WithCreateDedicatedDatabaseId(""), ) ``` diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create.md b/examples/1.9.x/server-graphql/examples/tablesdb/create.md index ce124f560..c56893773 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create.md @@ -3,7 +3,8 @@ mutation { tablesDBCreate( databaseId: "", name: "", - enabled: false + enabled: false, + dedicatedDatabaseId: "" ) { _id name @@ -44,7 +45,8 @@ mutation { tablesDBCreate( databaseId: "", name: "", - enabled: false + enabled: false, + dedicatedDatabaseId: "" ) { _id name diff --git a/examples/1.9.x/server-kotlin/java/tablesdb/create.md b/examples/1.9.x/server-kotlin/java/tablesdb/create.md index ccd99cc2d..5b9453340 100644 --- a/examples/1.9.x/server-kotlin/java/tablesdb/create.md +++ b/examples/1.9.x/server-kotlin/java/tablesdb/create.md @@ -14,6 +14,7 @@ tablesDB.create( "", // databaseId "", // name false, // enabled (optional) + "", // dedicatedDatabaseId (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { error.printStackTrace(); diff --git a/examples/1.9.x/server-kotlin/kotlin/tablesdb/create.md b/examples/1.9.x/server-kotlin/kotlin/tablesdb/create.md index 622f66e2a..c13173da9 100644 --- a/examples/1.9.x/server-kotlin/kotlin/tablesdb/create.md +++ b/examples/1.9.x/server-kotlin/kotlin/tablesdb/create.md @@ -13,6 +13,7 @@ val tablesDB = TablesDB(client) val response = tablesDB.create( databaseId = "", name = "", - enabled = false // optional + enabled = false, // optional + dedicatedDatabaseId = "" // optional ) ``` diff --git a/examples/1.9.x/server-nodejs/examples/tablesdb/create.md b/examples/1.9.x/server-nodejs/examples/tablesdb/create.md index 0571906c5..cc39ad924 100644 --- a/examples/1.9.x/server-nodejs/examples/tablesdb/create.md +++ b/examples/1.9.x/server-nodejs/examples/tablesdb/create.md @@ -11,6 +11,7 @@ const tablesDB = new sdk.TablesDB(client); const result = await tablesDB.create({ databaseId: '', name: '', - enabled: false // optional + enabled: false, // optional + dedicatedDatabaseId: '' // optional }); ``` diff --git a/examples/1.9.x/server-php/examples/tablesdb/create.md b/examples/1.9.x/server-php/examples/tablesdb/create.md index 2265fc9bb..34d305693 100644 --- a/examples/1.9.x/server-php/examples/tablesdb/create.md +++ b/examples/1.9.x/server-php/examples/tablesdb/create.md @@ -14,5 +14,6 @@ $tablesDB = new TablesDB($client); $result = $tablesDB->create( databaseId: '', name: '', - enabled: false // optional + enabled: false, // optional + dedicatedDatabaseId: '' // optional );``` diff --git a/examples/1.9.x/server-python/examples/tablesdb/create.md b/examples/1.9.x/server-python/examples/tablesdb/create.md index fb6bf0fb4..c50f28e71 100644 --- a/examples/1.9.x/server-python/examples/tablesdb/create.md +++ b/examples/1.9.x/server-python/examples/tablesdb/create.md @@ -13,7 +13,8 @@ tables_db = TablesDB(client) result: Database = tables_db.create( database_id = '', name = '', - enabled = False # optional + enabled = False, # optional + dedicated_database_id = '' # optional ) print(result.model_dump()) diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create.md b/examples/1.9.x/server-rest/examples/tablesdb/create.md index d17fd22e9..1be043d2b 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create.md @@ -9,12 +9,14 @@ X-Appwrite-Project: { "databaseId": "", "name": "", - "enabled": false + "enabled": false, + "dedicatedDatabaseId": "" } { "databaseId": "", "name": "", - "enabled": false + "enabled": false, + "dedicatedDatabaseId": "" } ``` diff --git a/examples/1.9.x/server-ruby/examples/tablesdb/create.md b/examples/1.9.x/server-ruby/examples/tablesdb/create.md index 4eba90afb..fd73173f5 100644 --- a/examples/1.9.x/server-ruby/examples/tablesdb/create.md +++ b/examples/1.9.x/server-ruby/examples/tablesdb/create.md @@ -13,6 +13,7 @@ tables_db = TablesDB.new(client) result = tables_db.create( database_id: '', name: '', - enabled: false # optional + enabled: false, # optional + dedicated_database_id: '' # optional ) ``` diff --git a/examples/1.9.x/server-rust/examples/tablesdb/create.md b/examples/1.9.x/server-rust/examples/tablesdb/create.md index 8a787bac1..ce76bfe0b 100644 --- a/examples/1.9.x/server-rust/examples/tablesdb/create.md +++ b/examples/1.9.x/server-rust/examples/tablesdb/create.md @@ -14,7 +14,8 @@ async fn main() -> Result<(), Box> { let result = tables_db.create( "", "", - Some(false) // optional + Some(false), // optional + Some("") // optional ).await?; let _ = result; diff --git a/examples/1.9.x/server-swift/examples/tablesdb/create.md b/examples/1.9.x/server-swift/examples/tablesdb/create.md index 91fe76a73..8b3e94646 100644 --- a/examples/1.9.x/server-swift/examples/tablesdb/create.md +++ b/examples/1.9.x/server-swift/examples/tablesdb/create.md @@ -11,7 +11,8 @@ let tablesDB = TablesDB(client) let database = try await tablesDB.create( databaseId: "", name: "", - enabled: false // optional + enabled: false, // optional + dedicatedDatabaseId: "" // optional ) ``` diff --git a/specs/1.9.x/open-api3-1.9.x-client.json b/specs/1.9.x/open-api3-1.9.x-client.json index a0bba0dd4..117835d6d 100644 --- a/specs/1.9.x/open-api3-1.9.x-client.json +++ b/specs/1.9.x/open-api3-1.9.x-client.json @@ -4176,6 +4176,49 @@ "description": "Application name.", "x-example": "" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "default": "", + "x-example": "" + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, "redirectUris": { "type": "array", "description": "Redirect URIs (array of valid URLs).", @@ -4355,6 +4398,49 @@ "description": "Application name.", "x-example": "" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "default": "", + "x-example": "" + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, "enabled": { "type": "boolean", "description": "Is application enabled?", @@ -10622,12 +10708,12 @@ "packaging": false, "public": true, "auth": { - "ProjectQuery": [] + "ProjectPath": [] } }, "security": [ { - "ProjectQuery": [], + "ProjectPath": [], "Session": [], "JWT": [] } @@ -10635,7 +10721,7 @@ "parameters": [ { "name": "project_id", - "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "description": "Project ID in which OAuth2 client exists.", "required": true, "schema": { "type": "string", @@ -10709,12 +10795,12 @@ "packaging": false, "public": true, "auth": { - "ProjectQuery": [] + "ProjectPath": [] } }, "security": [ { - "ProjectQuery": [], + "ProjectPath": [], "Session": [], "JWT": [] } @@ -11043,12 +11129,12 @@ "packaging": false, "public": true, "auth": { - "ProjectQuery": [] + "ProjectPath": [] } }, "security": [ { - "ProjectQuery": [], + "ProjectPath": [], "Session": [], "JWT": [] } @@ -11056,7 +11142,7 @@ "parameters": [ { "name": "project_id", - "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "description": "Project ID in which OAuth2 client exists.", "required": true, "schema": { "type": "string", @@ -16151,10 +16237,6 @@ "name": "users", "description": "The Users service allows you to manage your project users." }, - { - "name": "presences", - "description": "The Presences service allows you to create, query, and manage realtime presence state." - }, { "name": "sites", "description": "The Sites Service allows you view, create and manage your web applications." @@ -19052,6 +19134,41 @@ "description": "Application name.", "x-example": "My Application" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "x-example": "Connect your workspace to My Application." + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/logo.png" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/privacy" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/terms" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails.", + "items": { + "type": "string" + }, + "x-example": [ + "support@example.com" + ] + }, "redirectUris": { "type": "array", "description": "List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.", @@ -19101,6 +19218,12 @@ "$createdAt", "$updatedAt", "name", + "description", + "clientUri", + "logoUri", + "privacyPolicyUrl", + "termsUrl", + "contacts", "redirectUris", "enabled", "type", @@ -19114,6 +19237,14 @@ "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ], "redirectUris": [ "https:\/\/example.com\/callback" ], @@ -19329,6 +19460,79 @@ "redirectUrl": "https:\/\/example.com\/callback?error=access_denied&state=fghij" } }, + "oauth2GrantApp": { + "description": "OAuth2 Grant App", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 client app ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "OAuth2 client app name.", + "x-example": "My Application" + }, + "description": { + "type": "string", + "description": "OAuth2 client app description shown during consent.", + "x-example": "Connect your workspace to My Application." + }, + "clientUri": { + "type": "string", + "description": "OAuth2 client app homepage URL shown during consent.", + "x-example": "https:\/\/example.com" + }, + "logoUri": { + "type": "string", + "description": "OAuth2 client app logo URL shown during consent.", + "x-example": "https:\/\/example.com\/logo.png" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "OAuth2 client app privacy policy URL shown during consent.", + "x-example": "https:\/\/example.com\/privacy" + }, + "termsUrl": { + "type": "string", + "description": "OAuth2 client app terms of service URL shown during consent.", + "x-example": "https:\/\/example.com\/terms" + }, + "contacts": { + "type": "array", + "description": "OAuth2 client app support or security contact emails.", + "items": { + "type": "string" + }, + "x-example": [ + "support@example.com" + ] + } + }, + "required": [ + "$id", + "name", + "description", + "clientUri", + "logoUri", + "privacyPolicyUrl", + "termsUrl", + "contacts" + ], + "example": { + "$id": "5e5ea5c16897e", + "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ] + } + }, "oauth2Grant": { "description": "OAuth2 Grant", "type": "object", @@ -19358,6 +19562,25 @@ "description": "ID of the OAuth2 client (app) the grant was requested for.", "x-example": "5e5ea5c16897e" }, + "app": { + "type": "object", + "description": "Public OAuth2 client metadata shown during consent.", + "x-example": { + "$id": "5e5ea5c16897e", + "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ] + }, + "items": { + "$ref": "#\/components\/schemas\/oauth2GrantApp" + } + }, "scopes": { "type": "array", "description": "Requested OAuth2 scopes the user is being asked to consent to.", @@ -19403,6 +19626,7 @@ "$updatedAt", "userId", "appId", + "app", "scopes", "authorizationDetails", "prompt", @@ -19416,6 +19640,18 @@ "$updatedAt": "2020-10-15T06:38:00.000+00:00", "userId": "5e5ea5c16897e", "appId": "5e5ea5c16897e", + "app": { + "$id": "5e5ea5c16897e", + "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ] + }, "scopes": [ "openid", "email", @@ -19495,12 +19731,14 @@ "demo": "" } }, - "ProjectQuery": { + "ProjectPath": { "type": "apiKey", "name": "project", "description": "Your project ID", "in": "query", "x-appwrite": { + "location": "path", + "param": "project_id", "demo": "" } }, diff --git a/specs/1.9.x/open-api3-1.9.x-console.json b/specs/1.9.x/open-api3-1.9.x-console.json index d95039efa..56289149b 100644 --- a/specs/1.9.x/open-api3-1.9.x-console.json +++ b/specs/1.9.x/open-api3-1.9.x-console.json @@ -5654,6 +5654,49 @@ "description": "Application name.", "x-example": "" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "default": "", + "x-example": "" + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, "redirectUris": { "type": "array", "description": "Redirect URIs (array of valid URLs).", @@ -5835,6 +5878,49 @@ "description": "Application name.", "x-example": "" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "default": "", + "x-example": "" + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, "enabled": { "type": "boolean", "description": "Is application enabled?", @@ -9427,6 +9513,12 @@ "description": "Enable connection pooler on provision.", "default": true, "x-example": false + }, + "api": { + "type": "string", + "description": "Product API that owns this database: compute (raw, direct-access), tablesdb, documentsdb, or vectorsdb. tablesdb\/documentsdb\/vectorsdb computes are reached only through their product APIs.", + "default": "compute", + "x-example": "compute" } }, "required": [ @@ -22701,11 +22793,14 @@ "default": true, "x-example": false }, - "specification": { + "dedicatedDatabaseId": { "type": "string", - "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", - "default": "free", - "x-example": "" + "description": "Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.", + "default": "", + "x-example": "", + "x-appwrite": { + "idGenerator": "ID.unique" + } } }, "required": [ @@ -55714,7 +55809,7 @@ "parameters": [ { "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, documentsDB, tablesDB, vectorsDB, locale, health, project, storage, teams, users, vcs, webhooks, tokens, presences, sites, functions, proxy, graphql, migrations, messaging, advisor", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor", "required": true, "schema": { "type": "string", @@ -55724,9 +55819,6 @@ "avatars", "databases", "tablesdb", - "documentsDB", - "tablesDB", - "vectorsDB", "locale", "health", "project", @@ -55734,9 +55826,6 @@ "teams", "users", "vcs", - "webhooks", - "tokens", - "presences", "sites", "functions", "proxy", @@ -63179,6 +63268,15 @@ "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 + }, + "dedicatedDatabaseId": { + "type": "string", + "description": "Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.", + "default": "", + "x-example": "", + "x-appwrite": { + "idGenerator": "ID.unique" + } } }, "required": [ @@ -77916,11 +78014,14 @@ "default": true, "x-example": false }, - "specification": { + "dedicatedDatabaseId": { "type": "string", - "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", - "default": "free", - "x-example": "" + "description": "Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.", + "default": "", + "x-example": "", + "x-appwrite": { + "idGenerator": "ID.unique" + } } }, "required": [ @@ -81437,18 +81538,6 @@ "name": "tablesdb", "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows" }, - { - "name": "documentsDB", - "description": "The DocumentsDB service allows you to create structured collections of documents, query and filter lists of documents." - }, - { - "name": "tablesDB", - "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows." - }, - { - "name": "vectorsDB", - "description": "The VectorsDB service allows you to create vector collections, embeddings, indexes, and documents." - }, { "name": "locale", "description": "The Locale service allows you to customize your app based on your users' location." @@ -81477,18 +81566,6 @@ "name": "users", "description": "The Users service allows you to manage your project users." }, - { - "name": "webhooks", - "description": "The Webhooks service allows you to configure event-driven HTTP callbacks for your project." - }, - { - "name": "tokens", - "description": "The Tokens service allows you to create and manage resource tokens for project resources." - }, - { - "name": "presences", - "description": "The Presences service allows you to create, query, and manage realtime presence state." - }, { "name": "sites", "description": "The Sites Service allows you view, create and manage your web applications." @@ -81509,10 +81586,6 @@ "name": "console", "description": "The Console service allows you to interact with console relevant information." }, - { - "name": "assistant", - "description": "The Assistant service allows Console users to ask assistant queries." - }, { "name": "organization", "description": "The Organization service allows you to manage organization-level projects." @@ -92718,9 +92791,6 @@ "avatars", "databases", "tablesdb", - "documentsDB", - "tablesDB", - "vectorsDB", "locale", "health", "project", @@ -92728,9 +92798,6 @@ "teams", "users", "vcs", - "webhooks", - "tokens", - "presences", "sites", "functions", "proxy", @@ -107232,6 +107299,41 @@ "description": "Application name.", "x-example": "My Application" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "x-example": "Connect your workspace to My Application." + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/logo.png" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/privacy" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/terms" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails.", + "items": { + "type": "string" + }, + "x-example": [ + "support@example.com" + ] + }, "redirectUris": { "type": "array", "description": "List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.", @@ -107281,6 +107383,12 @@ "$createdAt", "$updatedAt", "name", + "description", + "clientUri", + "logoUri", + "privacyPolicyUrl", + "termsUrl", + "contacts", "redirectUris", "enabled", "type", @@ -107294,6 +107402,14 @@ "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ], "redirectUris": [ "https:\/\/example.com\/callback" ], @@ -108106,12 +108222,14 @@ "demo": "" } }, - "ProjectQuery": { + "ProjectPath": { "type": "apiKey", "name": "project", "description": "Your project ID", "in": "query", "x-appwrite": { + "location": "path", + "param": "project_id", "demo": "" } }, diff --git a/specs/1.9.x/open-api3-1.9.x-server.json b/specs/1.9.x/open-api3-1.9.x-server.json index f589b3f63..0067c79b8 100644 --- a/specs/1.9.x/open-api3-1.9.x-server.json +++ b/specs/1.9.x/open-api3-1.9.x-server.json @@ -4013,6 +4013,49 @@ "description": "Application name.", "x-example": "" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "default": "", + "x-example": "" + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, "redirectUris": { "type": "array", "description": "Redirect URIs (array of valid URLs).", @@ -4196,6 +4239,49 @@ "description": "Application name.", "x-example": "" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "default": "", + "x-example": "" + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, "enabled": { "type": "boolean", "description": "Is application enabled?", @@ -15672,11 +15758,14 @@ "default": true, "x-example": false }, - "specification": { + "dedicatedDatabaseId": { "type": "string", - "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", - "default": "free", - "x-example": "" + "description": "Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.", + "default": "", + "x-example": "", + "x-appwrite": { + "idGenerator": "ID.unique" + } } }, "required": [ @@ -29616,13 +29705,13 @@ "packaging": false, "public": true, "auth": { - "ProjectQuery": [], + "ProjectPath": [], "Session": [] } }, "security": [ { - "ProjectQuery": [], + "ProjectPath": [], "Session": [], "JWT": [] } @@ -29630,7 +29719,7 @@ "parameters": [ { "name": "project_id", - "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "description": "Project ID in which OAuth2 client exists.", "required": true, "schema": { "type": "string", @@ -29704,13 +29793,13 @@ "packaging": false, "public": true, "auth": { - "ProjectQuery": [], + "ProjectPath": [], "Session": [] } }, "security": [ { - "ProjectQuery": [], + "ProjectPath": [], "Session": [], "JWT": [] } @@ -30042,13 +30131,13 @@ "packaging": false, "public": true, "auth": { - "ProjectQuery": [], + "ProjectPath": [], "Session": [] } }, "security": [ { - "ProjectQuery": [], + "ProjectPath": [], "Session": [], "JWT": [] } @@ -30056,7 +30145,7 @@ "parameters": [ { "name": "project_id", - "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "description": "Project ID in which OAuth2 client exists.", "required": true, "schema": { "type": "string", @@ -39058,7 +39147,7 @@ "parameters": [ { "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, documentsDB, tablesDB, vectorsDB, locale, health, project, storage, teams, users, vcs, webhooks, tokens, presences, sites, functions, proxy, graphql, migrations, messaging, advisor", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor", "required": true, "schema": { "type": "string", @@ -39068,9 +39157,6 @@ "avatars", "databases", "tablesdb", - "documentsDB", - "tablesDB", - "vectorsDB", "locale", "health", "project", @@ -39078,9 +39164,6 @@ "teams", "users", "vcs", - "webhooks", - "tokens", - "presences", "sites", "functions", "proxy", @@ -45154,6 +45237,15 @@ "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 + }, + "dedicatedDatabaseId": { + "type": "string", + "description": "Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.", + "default": "", + "x-example": "", + "x-appwrite": { + "idGenerator": "ID.unique" + } } }, "required": [ @@ -58563,11 +58655,14 @@ "default": true, "x-example": false }, - "specification": { + "dedicatedDatabaseId": { "type": "string", - "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", - "default": "free", - "x-example": "" + "description": "Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.", + "default": "", + "x-example": "", + "x-appwrite": { + "idGenerator": "ID.unique" + } } }, "required": [ @@ -61828,18 +61923,6 @@ "name": "tablesdb", "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows" }, - { - "name": "documentsDB", - "description": "The DocumentsDB service allows you to create structured collections of documents, query and filter lists of documents." - }, - { - "name": "tablesDB", - "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows." - }, - { - "name": "vectorsDB", - "description": "The VectorsDB service allows you to create vector collections, embeddings, indexes, and documents." - }, { "name": "locale", "description": "The Locale service allows you to customize your app based on your users' location." @@ -61868,18 +61951,6 @@ "name": "users", "description": "The Users service allows you to manage your project users." }, - { - "name": "webhooks", - "description": "The Webhooks service allows you to configure event-driven HTTP callbacks for your project." - }, - { - "name": "tokens", - "description": "The Tokens service allows you to create and manage resource tokens for project resources." - }, - { - "name": "presences", - "description": "The Presences service allows you to create, query, and manage realtime presence state." - }, { "name": "sites", "description": "The Sites Service allows you view, create and manage your web applications." @@ -71529,9 +71600,6 @@ "avatars", "databases", "tablesdb", - "documentsDB", - "tablesDB", - "vectorsDB", "locale", "health", "project", @@ -71539,9 +71607,6 @@ "teams", "users", "vcs", - "webhooks", - "tokens", - "presences", "sites", "functions", "proxy", @@ -76886,6 +76951,41 @@ "description": "Application name.", "x-example": "My Application" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "x-example": "Connect your workspace to My Application." + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/logo.png" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/privacy" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/terms" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails.", + "items": { + "type": "string" + }, + "x-example": [ + "support@example.com" + ] + }, "redirectUris": { "type": "array", "description": "List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.", @@ -76935,6 +77035,12 @@ "$createdAt", "$updatedAt", "name", + "description", + "clientUri", + "logoUri", + "privacyPolicyUrl", + "termsUrl", + "contacts", "redirectUris", "enabled", "type", @@ -76948,6 +77054,14 @@ "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ], "redirectUris": [ "https:\/\/example.com\/callback" ], @@ -77163,6 +77277,79 @@ "redirectUrl": "https:\/\/example.com\/callback?error=access_denied&state=fghij" } }, + "oauth2GrantApp": { + "description": "OAuth2 Grant App", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 client app ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "OAuth2 client app name.", + "x-example": "My Application" + }, + "description": { + "type": "string", + "description": "OAuth2 client app description shown during consent.", + "x-example": "Connect your workspace to My Application." + }, + "clientUri": { + "type": "string", + "description": "OAuth2 client app homepage URL shown during consent.", + "x-example": "https:\/\/example.com" + }, + "logoUri": { + "type": "string", + "description": "OAuth2 client app logo URL shown during consent.", + "x-example": "https:\/\/example.com\/logo.png" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "OAuth2 client app privacy policy URL shown during consent.", + "x-example": "https:\/\/example.com\/privacy" + }, + "termsUrl": { + "type": "string", + "description": "OAuth2 client app terms of service URL shown during consent.", + "x-example": "https:\/\/example.com\/terms" + }, + "contacts": { + "type": "array", + "description": "OAuth2 client app support or security contact emails.", + "items": { + "type": "string" + }, + "x-example": [ + "support@example.com" + ] + } + }, + "required": [ + "$id", + "name", + "description", + "clientUri", + "logoUri", + "privacyPolicyUrl", + "termsUrl", + "contacts" + ], + "example": { + "$id": "5e5ea5c16897e", + "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ] + } + }, "oauth2Grant": { "description": "OAuth2 Grant", "type": "object", @@ -77192,6 +77379,25 @@ "description": "ID of the OAuth2 client (app) the grant was requested for.", "x-example": "5e5ea5c16897e" }, + "app": { + "type": "object", + "description": "Public OAuth2 client metadata shown during consent.", + "x-example": { + "$id": "5e5ea5c16897e", + "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ] + }, + "items": { + "$ref": "#\/components\/schemas\/oauth2GrantApp" + } + }, "scopes": { "type": "array", "description": "Requested OAuth2 scopes the user is being asked to consent to.", @@ -77237,6 +77443,7 @@ "$updatedAt", "userId", "appId", + "app", "scopes", "authorizationDetails", "prompt", @@ -77250,6 +77457,18 @@ "$updatedAt": "2020-10-15T06:38:00.000+00:00", "userId": "5e5ea5c16897e", "appId": "5e5ea5c16897e", + "app": { + "$id": "5e5ea5c16897e", + "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ] + }, "scopes": [ "openid", "email", @@ -77497,12 +77716,14 @@ "demo": "" } }, - "ProjectQuery": { + "ProjectPath": { "type": "apiKey", "name": "project", "description": "Your project ID", "in": "query", "x-appwrite": { + "location": "path", + "param": "project_id", "demo": "" } }, diff --git a/specs/1.9.x/swagger2-1.9.x-client.json b/specs/1.9.x/swagger2-1.9.x-client.json index 1c5f702b6..b7bde016a 100644 --- a/specs/1.9.x/swagger2-1.9.x-client.json +++ b/specs/1.9.x/swagger2-1.9.x-client.json @@ -38,12 +38,14 @@ "demo": "" } }, - "ProjectQuery": { + "ProjectPath": { "type": "apiKey", "name": "project", "description": "Your project ID", "in": "query", "x-appwrite": { + "location": "path", + "param": "project_id", "demo": "" } }, @@ -4401,6 +4403,49 @@ "description": "Application name.", "x-example": "" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "default": "", + "x-example": "" + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, "redirectUris": { "type": "array", "description": "Redirect URIs (array of valid URLs).", @@ -4574,6 +4619,49 @@ "description": "Application name.", "x-example": "" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "default": "", + "x-example": "" + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, "enabled": { "type": "boolean", "description": "Is application enabled?", @@ -11130,12 +11218,12 @@ "packaging": false, "public": true, "auth": { - "ProjectQuery": [] + "ProjectPath": [] } }, "security": [ { - "ProjectQuery": [], + "ProjectPath": [], "Session": [], "JWT": [] } @@ -11143,7 +11231,7 @@ "parameters": [ { "name": "project_id", - "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "description": "Project ID in which OAuth2 client exists.", "required": true, "type": "string", "x-example": "", @@ -11213,12 +11301,12 @@ "packaging": false, "public": true, "auth": { - "ProjectQuery": [] + "ProjectPath": [] } }, "security": [ { - "ProjectQuery": [], + "ProjectPath": [], "Session": [], "JWT": [] } @@ -11518,12 +11606,12 @@ "packaging": false, "public": true, "auth": { - "ProjectQuery": [] + "ProjectPath": [] } }, "security": [ { - "ProjectQuery": [], + "ProjectPath": [], "Session": [], "JWT": [] } @@ -11531,7 +11619,7 @@ "parameters": [ { "name": "project_id", - "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "description": "Project ID in which OAuth2 client exists.", "required": true, "type": "string", "x-example": "", @@ -16414,10 +16502,6 @@ "name": "users", "description": "The Users service allows you to manage your project users." }, - { - "name": "presences", - "description": "The Presences service allows you to create, query, and manage realtime presence state." - }, { "name": "sites", "description": "The Sites Service allows you view, create and manage your web applications." @@ -19299,6 +19383,41 @@ "description": "Application name.", "x-example": "My Application" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "x-example": "Connect your workspace to My Application." + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/logo.png" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/privacy" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/terms" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails.", + "items": { + "type": "string" + }, + "x-example": [ + "support@example.com" + ] + }, "redirectUris": { "type": "array", "description": "List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.", @@ -19349,6 +19468,12 @@ "$createdAt", "$updatedAt", "name", + "description", + "clientUri", + "logoUri", + "privacyPolicyUrl", + "termsUrl", + "contacts", "redirectUris", "enabled", "type", @@ -19362,6 +19487,14 @@ "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ], "redirectUris": [ "https:\/\/example.com\/callback" ], @@ -19577,6 +19710,79 @@ "redirectUrl": "https:\/\/example.com\/callback?error=access_denied&state=fghij" } }, + "oauth2GrantApp": { + "description": "OAuth2 Grant App", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 client app ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "OAuth2 client app name.", + "x-example": "My Application" + }, + "description": { + "type": "string", + "description": "OAuth2 client app description shown during consent.", + "x-example": "Connect your workspace to My Application." + }, + "clientUri": { + "type": "string", + "description": "OAuth2 client app homepage URL shown during consent.", + "x-example": "https:\/\/example.com" + }, + "logoUri": { + "type": "string", + "description": "OAuth2 client app logo URL shown during consent.", + "x-example": "https:\/\/example.com\/logo.png" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "OAuth2 client app privacy policy URL shown during consent.", + "x-example": "https:\/\/example.com\/privacy" + }, + "termsUrl": { + "type": "string", + "description": "OAuth2 client app terms of service URL shown during consent.", + "x-example": "https:\/\/example.com\/terms" + }, + "contacts": { + "type": "array", + "description": "OAuth2 client app support or security contact emails.", + "items": { + "type": "string" + }, + "x-example": [ + "support@example.com" + ] + } + }, + "required": [ + "$id", + "name", + "description", + "clientUri", + "logoUri", + "privacyPolicyUrl", + "termsUrl", + "contacts" + ], + "example": { + "$id": "5e5ea5c16897e", + "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ] + } + }, "oauth2Grant": { "description": "OAuth2 Grant", "type": "object", @@ -19606,6 +19812,26 @@ "description": "ID of the OAuth2 client (app) the grant was requested for.", "x-example": "5e5ea5c16897e" }, + "app": { + "type": "object", + "description": "Public OAuth2 client metadata shown during consent.", + "x-example": { + "$id": "5e5ea5c16897e", + "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ] + }, + "items": { + "type": "object", + "$ref": "#\/definitions\/oauth2GrantApp" + } + }, "scopes": { "type": "array", "description": "Requested OAuth2 scopes the user is being asked to consent to.", @@ -19651,6 +19877,7 @@ "$updatedAt", "userId", "appId", + "app", "scopes", "authorizationDetails", "prompt", @@ -19664,6 +19891,18 @@ "$updatedAt": "2020-10-15T06:38:00.000+00:00", "userId": "5e5ea5c16897e", "appId": "5e5ea5c16897e", + "app": { + "$id": "5e5ea5c16897e", + "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ] + }, "scopes": [ "openid", "email", diff --git a/specs/1.9.x/swagger2-1.9.x-console.json b/specs/1.9.x/swagger2-1.9.x-console.json index e838d8687..0e30d4264 100644 --- a/specs/1.9.x/swagger2-1.9.x-console.json +++ b/specs/1.9.x/swagger2-1.9.x-console.json @@ -38,12 +38,14 @@ "demo": "" } }, - "ProjectQuery": { + "ProjectPath": { "type": "apiKey", "name": "project", "description": "Your project ID", "in": "query", "x-appwrite": { + "location": "path", + "param": "project_id", "demo": "" } }, @@ -5910,6 +5912,49 @@ "description": "Application name.", "x-example": "" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "default": "", + "x-example": "" + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, "redirectUris": { "type": "array", "description": "Redirect URIs (array of valid URLs).", @@ -6085,6 +6130,49 @@ "description": "Application name.", "x-example": "" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "default": "", + "x-example": "" + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, "enabled": { "type": "boolean", "description": "Is application enabled?", @@ -10117,6 +10205,12 @@ "description": "Enable connection pooler on provision.", "default": true, "x-example": false + }, + "api": { + "type": "string", + "description": "Product API that owns this database: compute (raw, direct-access), tablesdb, documentsdb, or vectorsdb. tablesdb\/documentsdb\/vectorsdb computes are reached only through their product APIs.", + "default": "compute", + "x-example": "compute" } }, "required": [ @@ -23060,11 +23154,14 @@ "default": true, "x-example": false }, - "specification": { + "dedicatedDatabaseId": { "type": "string", - "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", - "default": "free", - "x-example": "" + "description": "Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.", + "default": "", + "x-example": "", + "x-appwrite": { + "idGenerator": "ID.unique" + } } }, "required": [ @@ -56873,7 +56970,7 @@ "parameters": [ { "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, documentsDB, tablesDB, vectorsDB, locale, health, project, storage, teams, users, vcs, webhooks, tokens, presences, sites, functions, proxy, graphql, migrations, messaging, advisor", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor", "required": true, "type": "string", "x-example": "account", @@ -56882,9 +56979,6 @@ "avatars", "databases", "tablesdb", - "documentsDB", - "tablesDB", - "vectorsDB", "locale", "health", "project", @@ -56892,9 +56986,6 @@ "teams", "users", "vcs", - "webhooks", - "tokens", - "presences", "sites", "functions", "proxy", @@ -56909,9 +57000,6 @@ "avatars", "databases", "tablesdb", - "documentsDB", - "tablesDB", - "vectorsDB", "locale", "health", "project", @@ -56919,9 +57007,6 @@ "teams", "users", "vcs", - "webhooks", - "tokens", - "presences", "sites", "functions", "proxy", @@ -64800,6 +64885,15 @@ "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 + }, + "dedicatedDatabaseId": { + "type": "string", + "description": "Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.", + "default": "", + "x-example": "", + "x-appwrite": { + "idGenerator": "ID.unique" + } } }, "required": [ @@ -79060,11 +79154,14 @@ "default": true, "x-example": false }, - "specification": { + "dedicatedDatabaseId": { "type": "string", - "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", - "default": "free", - "x-example": "" + "description": "Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.", + "default": "", + "x-example": "", + "x-appwrite": { + "idGenerator": "ID.unique" + } } }, "required": [ @@ -82477,18 +82574,6 @@ "name": "tablesdb", "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows" }, - { - "name": "documentsDB", - "description": "The DocumentsDB service allows you to create structured collections of documents, query and filter lists of documents." - }, - { - "name": "tablesDB", - "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows." - }, - { - "name": "vectorsDB", - "description": "The VectorsDB service allows you to create vector collections, embeddings, indexes, and documents." - }, { "name": "locale", "description": "The Locale service allows you to customize your app based on your users' location." @@ -82517,18 +82602,6 @@ "name": "users", "description": "The Users service allows you to manage your project users." }, - { - "name": "webhooks", - "description": "The Webhooks service allows you to configure event-driven HTTP callbacks for your project." - }, - { - "name": "tokens", - "description": "The Tokens service allows you to create and manage resource tokens for project resources." - }, - { - "name": "presences", - "description": "The Presences service allows you to create, query, and manage realtime presence state." - }, { "name": "sites", "description": "The Sites Service allows you view, create and manage your web applications." @@ -82549,10 +82622,6 @@ "name": "console", "description": "The Console service allows you to interact with console relevant information." }, - { - "name": "assistant", - "description": "The Assistant service allows Console users to ask assistant queries." - }, { "name": "organization", "description": "The Organization service allows you to manage organization-level projects." @@ -93818,9 +93887,6 @@ "avatars", "databases", "tablesdb", - "documentsDB", - "tablesDB", - "vectorsDB", "locale", "health", "project", @@ -93828,9 +93894,6 @@ "teams", "users", "vcs", - "webhooks", - "tokens", - "presences", "sites", "functions", "proxy", @@ -108524,6 +108587,41 @@ "description": "Application name.", "x-example": "My Application" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "x-example": "Connect your workspace to My Application." + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/logo.png" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/privacy" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/terms" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails.", + "items": { + "type": "string" + }, + "x-example": [ + "support@example.com" + ] + }, "redirectUris": { "type": "array", "description": "List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.", @@ -108574,6 +108672,12 @@ "$createdAt", "$updatedAt", "name", + "description", + "clientUri", + "logoUri", + "privacyPolicyUrl", + "termsUrl", + "contacts", "redirectUris", "enabled", "type", @@ -108587,6 +108691,14 @@ "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ], "redirectUris": [ "https:\/\/example.com\/callback" ], diff --git a/specs/1.9.x/swagger2-1.9.x-server.json b/specs/1.9.x/swagger2-1.9.x-server.json index eac966fce..03b9a09cf 100644 --- a/specs/1.9.x/swagger2-1.9.x-server.json +++ b/specs/1.9.x/swagger2-1.9.x-server.json @@ -38,12 +38,14 @@ "demo": "" } }, - "ProjectQuery": { + "ProjectPath": { "type": "apiKey", "name": "project", "description": "Your project ID", "in": "query", "x-appwrite": { + "location": "path", + "param": "project_id", "demo": "" } }, @@ -4205,6 +4207,49 @@ "description": "Application name.", "x-example": "" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "default": "", + "x-example": "" + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, "redirectUris": { "type": "array", "description": "Redirect URIs (array of valid URLs).", @@ -4382,6 +4427,49 @@ "description": "Application name.", "x-example": "" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "default": "", + "x-example": "" + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, "enabled": { "type": "boolean", "description": "Is application enabled?", @@ -15959,11 +16047,14 @@ "default": true, "x-example": false }, - "specification": { + "dedicatedDatabaseId": { "type": "string", - "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", - "default": "free", - "x-example": "" + "description": "Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.", + "default": "", + "x-example": "", + "x-appwrite": { + "idGenerator": "ID.unique" + } } }, "required": [ @@ -30108,13 +30199,13 @@ "packaging": false, "public": true, "auth": { - "ProjectQuery": [], + "ProjectPath": [], "Session": [] } }, "security": [ { - "ProjectQuery": [], + "ProjectPath": [], "Session": [], "JWT": [] } @@ -30122,7 +30213,7 @@ "parameters": [ { "name": "project_id", - "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "description": "Project ID in which OAuth2 client exists.", "required": true, "type": "string", "x-example": "", @@ -30192,13 +30283,13 @@ "packaging": false, "public": true, "auth": { - "ProjectQuery": [], + "ProjectPath": [], "Session": [] } }, "security": [ { - "ProjectQuery": [], + "ProjectPath": [], "Session": [], "JWT": [] } @@ -30501,13 +30592,13 @@ "packaging": false, "public": true, "auth": { - "ProjectQuery": [], + "ProjectPath": [], "Session": [] } }, "security": [ { - "ProjectQuery": [], + "ProjectPath": [], "Session": [], "JWT": [] } @@ -30515,7 +30606,7 @@ "parameters": [ { "name": "project_id", - "description": "Project ID in which OAuth2 client that created grant during authorization exists.", + "description": "Project ID in which OAuth2 client exists.", "required": true, "type": "string", "x-example": "", @@ -39997,7 +40088,7 @@ "parameters": [ { "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, documentsDB, tablesDB, vectorsDB, locale, health, project, storage, teams, users, vcs, webhooks, tokens, presences, sites, functions, proxy, graphql, migrations, messaging, advisor", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor", "required": true, "type": "string", "x-example": "account", @@ -40006,9 +40097,6 @@ "avatars", "databases", "tablesdb", - "documentsDB", - "tablesDB", - "vectorsDB", "locale", "health", "project", @@ -40016,9 +40104,6 @@ "teams", "users", "vcs", - "webhooks", - "tokens", - "presences", "sites", "functions", "proxy", @@ -40033,9 +40118,6 @@ "avatars", "databases", "tablesdb", - "documentsDB", - "tablesDB", - "vectorsDB", "locale", "health", "project", @@ -40043,9 +40125,6 @@ "teams", "users", "vcs", - "webhooks", - "tokens", - "presences", "sites", "functions", "proxy", @@ -46563,6 +46642,15 @@ "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 + }, + "dedicatedDatabaseId": { + "type": "string", + "description": "Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.", + "default": "", + "x-example": "", + "x-appwrite": { + "idGenerator": "ID.unique" + } } }, "required": [ @@ -59548,11 +59636,14 @@ "default": true, "x-example": false }, - "specification": { + "dedicatedDatabaseId": { "type": "string", - "description": "Database specification defining compute resources (CPU, memory). Defaults to the free tier. Must be enabled on the organization plan.", - "default": "free", - "x-example": "" + "description": "Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.", + "default": "", + "x-example": "", + "x-appwrite": { + "idGenerator": "ID.unique" + } } }, "required": [ @@ -62721,18 +62812,6 @@ "name": "tablesdb", "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows" }, - { - "name": "documentsDB", - "description": "The DocumentsDB service allows you to create structured collections of documents, query and filter lists of documents." - }, - { - "name": "tablesDB", - "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows." - }, - { - "name": "vectorsDB", - "description": "The VectorsDB service allows you to create vector collections, embeddings, indexes, and documents." - }, { "name": "locale", "description": "The Locale service allows you to customize your app based on your users' location." @@ -62761,18 +62840,6 @@ "name": "users", "description": "The Users service allows you to manage your project users." }, - { - "name": "webhooks", - "description": "The Webhooks service allows you to configure event-driven HTTP callbacks for your project." - }, - { - "name": "tokens", - "description": "The Tokens service allows you to create and manage resource tokens for project resources." - }, - { - "name": "presences", - "description": "The Presences service allows you to create, query, and manage realtime presence state." - }, { "name": "sites", "description": "The Sites Service allows you view, create and manage your web applications." @@ -72450,9 +72517,6 @@ "avatars", "databases", "tablesdb", - "documentsDB", - "tablesDB", - "vectorsDB", "locale", "health", "project", @@ -72460,9 +72524,6 @@ "teams", "users", "vcs", - "webhooks", - "tokens", - "presences", "sites", "functions", "proxy", @@ -77813,6 +77874,41 @@ "description": "Application name.", "x-example": "My Application" }, + "description": { + "type": "string", + "description": "Application description shown to users during OAuth2 consent.", + "x-example": "Connect your workspace to My Application." + }, + "clientUri": { + "type": "string", + "description": "Application homepage URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com" + }, + "logoUri": { + "type": "string", + "description": "Application logo URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/logo.png" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "Application privacy policy URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/privacy" + }, + "termsUrl": { + "type": "string", + "description": "Application terms of service URL shown to users during OAuth2 consent.", + "x-example": "https:\/\/example.com\/terms" + }, + "contacts": { + "type": "array", + "description": "Application support or security contact emails.", + "items": { + "type": "string" + }, + "x-example": [ + "support@example.com" + ] + }, "redirectUris": { "type": "array", "description": "List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.", @@ -77863,6 +77959,12 @@ "$createdAt", "$updatedAt", "name", + "description", + "clientUri", + "logoUri", + "privacyPolicyUrl", + "termsUrl", + "contacts", "redirectUris", "enabled", "type", @@ -77876,6 +77978,14 @@ "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ], "redirectUris": [ "https:\/\/example.com\/callback" ], @@ -78091,6 +78201,79 @@ "redirectUrl": "https:\/\/example.com\/callback?error=access_denied&state=fghij" } }, + "oauth2GrantApp": { + "description": "OAuth2 Grant App", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 client app ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "OAuth2 client app name.", + "x-example": "My Application" + }, + "description": { + "type": "string", + "description": "OAuth2 client app description shown during consent.", + "x-example": "Connect your workspace to My Application." + }, + "clientUri": { + "type": "string", + "description": "OAuth2 client app homepage URL shown during consent.", + "x-example": "https:\/\/example.com" + }, + "logoUri": { + "type": "string", + "description": "OAuth2 client app logo URL shown during consent.", + "x-example": "https:\/\/example.com\/logo.png" + }, + "privacyPolicyUrl": { + "type": "string", + "description": "OAuth2 client app privacy policy URL shown during consent.", + "x-example": "https:\/\/example.com\/privacy" + }, + "termsUrl": { + "type": "string", + "description": "OAuth2 client app terms of service URL shown during consent.", + "x-example": "https:\/\/example.com\/terms" + }, + "contacts": { + "type": "array", + "description": "OAuth2 client app support or security contact emails.", + "items": { + "type": "string" + }, + "x-example": [ + "support@example.com" + ] + } + }, + "required": [ + "$id", + "name", + "description", + "clientUri", + "logoUri", + "privacyPolicyUrl", + "termsUrl", + "contacts" + ], + "example": { + "$id": "5e5ea5c16897e", + "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ] + } + }, "oauth2Grant": { "description": "OAuth2 Grant", "type": "object", @@ -78120,6 +78303,26 @@ "description": "ID of the OAuth2 client (app) the grant was requested for.", "x-example": "5e5ea5c16897e" }, + "app": { + "type": "object", + "description": "Public OAuth2 client metadata shown during consent.", + "x-example": { + "$id": "5e5ea5c16897e", + "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ] + }, + "items": { + "type": "object", + "$ref": "#\/definitions\/oauth2GrantApp" + } + }, "scopes": { "type": "array", "description": "Requested OAuth2 scopes the user is being asked to consent to.", @@ -78165,6 +78368,7 @@ "$updatedAt", "userId", "appId", + "app", "scopes", "authorizationDetails", "prompt", @@ -78178,6 +78382,18 @@ "$updatedAt": "2020-10-15T06:38:00.000+00:00", "userId": "5e5ea5c16897e", "appId": "5e5ea5c16897e", + "app": { + "$id": "5e5ea5c16897e", + "name": "My Application", + "description": "Connect your workspace to My Application.", + "clientUri": "https:\/\/example.com", + "logoUri": "https:\/\/example.com\/logo.png", + "privacyPolicyUrl": "https:\/\/example.com\/privacy", + "termsUrl": "https:\/\/example.com\/terms", + "contacts": [ + "support@example.com" + ] + }, "scopes": [ "openid", "email",