Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
# Change Log

## 27.0.0

* Breaking: Removed `Health` service with its models and enums
* Breaking: Removed `Usage` service and usage models
* Breaking: Removed `Messaging` methods `listMessageLogs`, `listProviderLogs`, `listSubscriberLogs`, `listTopicLogs`
* Breaking: Renamed `TablesDB::create` parameter `dedicatedDatabaseId` to `specification`
* Breaking: Removed `countryCode` and `countryName` from `ActivityEvent` model
* Added: `Organization` service `get`, `update`, `delete`, and membership CRUD methods
* Added: `Client::setSigningKey` and `Client::setBearer` for JWT and bearer authentication
* Added: vector query helpers `Query::vectorDot`, `Query::vectorCosine`, `Query::vectorEuclidean`
* Added: `appwrite` OAuth2 provider and `Project::updateOAuth2Appwrite` method
* Added: `prompt` and `maxAge` parameters to `updateOAuth2Oidc`, `defaultScopes` to `updateOAuth2Server`
* Added: `newSpecification` parameter to `Backups::createRestoration`
* Added: `type` parameter to `Functions` and `Sites` `listSpecifications`
* Added: `token` parameter to `Functions::getDeploymentDownload`
* Added: `mode` to `Block`, `status` to `Database`, geolocation/ISP fields to `Locale` models
* Added: `onboarding` and `oAuth2ServerDefaultScopes` to `Project` model
* Added: organization membership, organization, and `project.oauth2`/`stages` key scopes
* Added: billing plan models, `BillingPlanGroup`, `DatabaseStatus`, OIDC prompt enums
* Updated: deprecated `Databases` transaction and text attribute methods in favor of `TablesDB`

## 26.1.0

* Updated: Reworked `usage.listEvents` into an aggregation query with `metric`, `interval`, `dimensions`, and `orderBy`
Expand Down
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
"require": {
"php": ">=8.2.0",
"ext-curl": "*",
"ext-json": "*"
"ext-json": "*",
"adhocore/jwt": "^1.1"
},
"require-dev": {
"phpunit/phpunit": "^12",
Expand Down
2 changes: 1 addition & 1 deletion docs/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -565,7 +565,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about

| Field Name | Type | Description | Default |
| --- | --- | --- | --- |
| provider | string | **Required** OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom. | |
| provider | string | **Required** OAuth2 Provider. Currently, supported providers are: amazon, apple, appwrite, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom. | |
| success | string | URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API. | |
| failure | string | URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API. | |
| scopes | array | A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long. | [] |
Expand Down
6 changes: 5 additions & 1 deletion docs/backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,10 @@ DELETE https://cloud.appwrite.io/v1/backups/policies/{policyId}
POST https://cloud.appwrite.io/v1/backups/restoration
```

** Create and trigger a new restoration for a backup on a project. **
** Create and trigger a new restoration for a backup on a project.

When restoring a DocumentsDB or VectorsDB database to a new resource, pass `newSpecification` to provision the restored database on a different specification than the archived one (for example, restoring onto a larger or smaller dedicated database). Use `serverless` to restore onto the shared pool, or a dedicated specification slug to restore onto a dedicated database of that size. The specification must be permitted by the organization's plan. `newSpecification` is not supported for legacy/TablesDB databases or for bucket restores.
**

### Parameters

Expand All @@ -143,6 +146,7 @@ POST https://cloud.appwrite.io/v1/backups/restoration
| services | array | Array of services to restore | |
| newResourceId | string | Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. | |
| newResourceName | string | Database name. Max length: 128 chars. | |
| newSpecification | string | Specification to provision the restored database on, when restoring a DocumentsDB or VectorsDB database to a new resource. Defaults to the archived database's specification. Use `serverless` for the shared pool or a dedicated specification slug. | |


```http request
Expand Down
3 changes: 2 additions & 1 deletion docs/examples/backups/create-restoration.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@ $result = $backups->createRestoration(
archiveId: '<ARCHIVE_ID>',
services: [BackupServices::DATABASES()],
newResourceId: '<NEW_RESOURCE_ID>', // optional
newResourceName: '<NEW_RESOURCE_NAME>' // optional
newResourceName: '<NEW_RESOURCE_NAME>', // optional
newSpecification: 'serverless' // optional
);```
3 changes: 2 additions & 1 deletion docs/examples/functions/get-deployment-download.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ $functions = new Functions($client);
$result = $functions->getDeploymentDownload(
functionId: '<FUNCTION_ID>',
deploymentId: '<DEPLOYMENT_ID>',
type: DeploymentDownloadType::SOURCE() // optional
type: DeploymentDownloadType::SOURCE(), // optional
token: '<TOKEN>' // optional
);```
5 changes: 3 additions & 2 deletions docs/examples/functions/list-specifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@ $client = (new Client())

$functions = new Functions($client);

$result = $functions->listSpecifications();
```
$result = $functions->listSpecifications(
type: 'runtimes' // optional
);```
15 changes: 0 additions & 15 deletions docs/examples/health/get-audits-db.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/examples/health/get-cache.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/examples/health/get-certificate.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/examples/health/get-db.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/examples/health/get-pub-sub.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/examples/health/get-queue-databases.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/examples/health/get-queue-deletes.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/examples/health/get-queue-functions.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/examples/health/get-queue-logs.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/examples/health/get-queue-mails.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/examples/health/get-queue-messaging.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/examples/health/get-queue-migrations.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/examples/health/get-queue-stats-resources.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/examples/health/get-queue-usage.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/examples/health/get-queue-webhooks.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/examples/health/get-storage-local.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/examples/health/get-storage.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/examples/health/get-time.md

This file was deleted.

Loading