mirror of
https://github.com/LukeHagar/website.git
synced 2025-12-06 04:22:07 +00:00
chore: formatting
This commit is contained in:
ChiragAgg5k
18
CONTENT.md
18
CONTENT.md
@@ -49,9 +49,9 @@ Create ordered (numbered) and unordered (bulleted) lists using 1., \*, or -.
|
||||
**Unordered List**:
|
||||
|
||||
```md
|
||||
- Apple
|
||||
- Banana
|
||||
- Cherry
|
||||
- Apple
|
||||
- Banana
|
||||
- Cherry
|
||||
```
|
||||
|
||||
#### Links
|
||||
@@ -130,18 +130,18 @@ Alternatively, use markdoc tables.
|
||||
```md
|
||||
{% table %}
|
||||
|
||||
- Heading 1
|
||||
- Heading 2
|
||||
- Heading 1
|
||||
- Heading 2
|
||||
|
||||
---
|
||||
|
||||
- Row 1 Cell 1
|
||||
- Row 1 Cell 2
|
||||
- Row 1 Cell 1
|
||||
- Row 1 Cell 2
|
||||
|
||||
---
|
||||
|
||||
- Row 2 Cell 1
|
||||
- Row 2 cell 2
|
||||
- Row 2 Cell 1
|
||||
- Row 2 cell 2
|
||||
|
||||
{% /table %}
|
||||
```
|
||||
|
||||
@@ -60,11 +60,11 @@ doc-548-submit-a-pull-request-section-to-contribution-guide
|
||||
|
||||
When `TYPE` can be:
|
||||
|
||||
- **feat** - is a new feature
|
||||
- **doc** - documentation only changes
|
||||
- **cicd** - changes related to CI/CD system
|
||||
- **fix** - a bug fix
|
||||
- **refactor** - code change that neither fixes a bug nor adds a feature
|
||||
- **feat** - is a new feature
|
||||
- **doc** - documentation only changes
|
||||
- **cicd** - changes related to CI/CD system
|
||||
- **fix** - a bug fix
|
||||
- **refactor** - code change that neither fixes a bug nor adds a feature
|
||||
|
||||
**All PRs must include a commit message with a description of the changes made!**
|
||||
|
||||
|
||||
@@ -10,8 +10,8 @@ The Appwrite Website repo features the main Appwrite website, including our [hom
|
||||
|
||||
The Appwrite Website has been built with the following frameworks:
|
||||
|
||||
- [Svelte](https://svelte.dev/)
|
||||
- [SvelteKit](https://kit.svelte.dev/)
|
||||
- [Svelte](https://svelte.dev/)
|
||||
- [SvelteKit](https://kit.svelte.dev/)
|
||||
|
||||
## Development
|
||||
|
||||
|
||||
192
STYLE.md
192
STYLE.md
@@ -6,17 +6,17 @@ Read this document carefully before making PRs to the Appwrite Website repo.
|
||||
|
||||
The Appwrite documentation is meant to provide general guidance that's:
|
||||
|
||||
- Unopinionated
|
||||
- Focused on the correct use of Appwrite product
|
||||
- Includes examples for all relevant and applicable SDKs
|
||||
- Agnostic to the user's implementation and stack.
|
||||
- Unopinionated
|
||||
- Focused on the correct use of Appwrite product
|
||||
- Includes examples for all relevant and applicable SDKs
|
||||
- Agnostic to the user's implementation and stack.
|
||||
|
||||
Examples of things not fit for docs, and better as a blog or video:
|
||||
|
||||
- General programming advice
|
||||
- Opinionated implementation patterns like MVVM, factory methods, etc.
|
||||
- Examples that only include a select subset of Appwrite SDKs.
|
||||
- Examples that do not work for all developers using Appwrite, but specific to Appwrite + technology.
|
||||
- General programming advice
|
||||
- Opinionated implementation patterns like MVVM, factory methods, etc.
|
||||
- Examples that only include a select subset of Appwrite SDKs.
|
||||
- Examples that do not work for all developers using Appwrite, but specific to Appwrite + technology.
|
||||
|
||||
Note that the tutorials and blogs available on the Appwrite blog and docs are meant for these types of information.
|
||||
|
||||
@@ -28,39 +28,39 @@ Appwrite's navigation increases in complexity from top down. We expect users to
|
||||
|
||||
Introduction Section:
|
||||
|
||||
- [Homes](https://appwrite.io/docs)
|
||||
- [Quick start](https://appwrite.io/docs/quick-start)
|
||||
- [Tutorial](https://appwrite.io/docs/tutorial)
|
||||
- [SDKs](https://appwrite.io/docs/sdks)
|
||||
- [API references](https://appwrite.io/docs/references)
|
||||
- [Homes](https://appwrite.io/docs)
|
||||
- [Quick start](https://appwrite.io/docs/quick-start)
|
||||
- [Tutorial](https://appwrite.io/docs/tutorial)
|
||||
- [SDKs](https://appwrite.io/docs/sdks)
|
||||
- [API references](https://appwrite.io/docs/references)
|
||||
|
||||
Products section:
|
||||
|
||||
- [Auth](https://appwrite.io/docs/products/auth)
|
||||
- [Databases](https://appwrite.io/docs/products/databases)
|
||||
- [Functions](https://appwrite.io/docs/products/functions)
|
||||
- [Storage](https://appwrite.io/docs/products/storage)
|
||||
- [Messaging](https://appwrite.io/docs/products/messaging)
|
||||
- [AI](https://appwrite.io/docs/products/ai)
|
||||
- [Auth](https://appwrite.io/docs/products/auth)
|
||||
- [Databases](https://appwrite.io/docs/products/databases)
|
||||
- [Functions](https://appwrite.io/docs/products/functions)
|
||||
- [Storage](https://appwrite.io/docs/products/storage)
|
||||
- [Messaging](https://appwrite.io/docs/products/messaging)
|
||||
- [AI](https://appwrite.io/docs/products/ai)
|
||||
|
||||
APIs section:
|
||||
|
||||
- [GraphQL](https://appwrite.io/docs/apis/graphql)
|
||||
- [REST](https://appwrite.io/docs/apis/rest)
|
||||
- [Realtime](https://appwrite.io/docs/apis/realtime)
|
||||
- [GraphQL](https://appwrite.io/docs/apis/graphql)
|
||||
- [REST](https://appwrite.io/docs/apis/rest)
|
||||
- [Realtime](https://appwrite.io/docs/apis/realtime)
|
||||
|
||||
Tooling section:
|
||||
|
||||
- [CLI](https://appwrite.io/docs/command-line)
|
||||
- [Command center](https://appwrite.io/docs/tooling/command-center)
|
||||
- [Assistant](https://appwrite.io/docs/tooling/assistant)
|
||||
- [CLI](https://appwrite.io/docs/command-line)
|
||||
- [Command center](https://appwrite.io/docs/tooling/command-center)
|
||||
- [Assistant](https://appwrite.io/docs/tooling/assistant)
|
||||
|
||||
Advanced section:
|
||||
|
||||
- [Platform](https://appwrite.io/docs/advanced/platform)
|
||||
- [Migrations](https://appwrite.io/docs/advanced/migrations)
|
||||
- [Self-hosting](https://appwrite.io/docs/advanced/self-hosting)
|
||||
- [Security](https://appwrite.io/docs/advanced/security)
|
||||
- [Platform](https://appwrite.io/docs/advanced/platform)
|
||||
- [Migrations](https://appwrite.io/docs/advanced/migrations)
|
||||
- [Self-hosting](https://appwrite.io/docs/advanced/self-hosting)
|
||||
- [Security](https://appwrite.io/docs/advanced/security)
|
||||
|
||||
Here's the intended purpose and structure of each section.
|
||||
|
||||
@@ -70,10 +70,10 @@ This section is focused on introducing what Appwrite is and giving examples to t
|
||||
Documentation here is focused on a **single flow** which means a single platform/framework + Appwrite.
|
||||
Content here is not specific to a specific product, but usually covers multiple Appwrite products.
|
||||
|
||||
- If your tutorial can be followed in about 15 minutes and fits on one page, write it under quick start
|
||||
- If you're writing a long piece of documentation that integrates Appwrite with another technology, with lots of details that's opinionated or isn't relevant for all use cases, write it under tutorial. This is similar to "cook book" at other organizations.
|
||||
- If you have information like helpers and methods that are only on SDKs but not the API, they go under SDK
|
||||
- API references are generated from source from the appwrite/appwrite repo
|
||||
- If your tutorial can be followed in about 15 minutes and fits on one page, write it under quick start
|
||||
- If you're writing a long piece of documentation that integrates Appwrite with another technology, with lots of details that's opinionated or isn't relevant for all use cases, write it under tutorial. This is similar to "cook book" at other organizations.
|
||||
- If you have information like helpers and methods that are only on SDKs but not the API, they go under SDK
|
||||
- API references are generated from source from the appwrite/appwrite repo
|
||||
|
||||
### Products
|
||||
|
||||
@@ -82,17 +82,17 @@ Code examples should cover **all available SDKs**.
|
||||
|
||||
Each product page has three main sections
|
||||
|
||||
- Introduction
|
||||
- Overview - Describes at a high level, why you might need this product
|
||||
- Quick start - Shows the most basic and quickest example to make something happen with a product. Keep it really short.
|
||||
- Concept
|
||||
- These pages usually align with sections shown in the product in the Appwrite Console.
|
||||
- Focused on describing concepts a user should know, but not actions you might take.
|
||||
- Cover all the details
|
||||
- Journeys
|
||||
- These pages focus on common actions and work flows
|
||||
- Detailed examples that span many concepts
|
||||
- Like cookbook at other organizations' documentation.
|
||||
- Introduction
|
||||
- Overview - Describes at a high level, why you might need this product
|
||||
- Quick start - Shows the most basic and quickest example to make something happen with a product. Keep it really short.
|
||||
- Concept
|
||||
- These pages usually align with sections shown in the product in the Appwrite Console.
|
||||
- Focused on describing concepts a user should know, but not actions you might take.
|
||||
- Cover all the details
|
||||
- Journeys
|
||||
- These pages focus on common actions and work flows
|
||||
- Detailed examples that span many concepts
|
||||
- Like cookbook at other organizations' documentation.
|
||||
|
||||
### APIs section
|
||||
|
||||
@@ -106,10 +106,10 @@ Describes tools that help you work with Appwrite, but are usually non-essential
|
||||
|
||||
For information that's not used commonly during the development cycle.
|
||||
|
||||
- Platform: covers concepts that apply to the entire Appwrite Cloud platform, like API keys, rate limits, etc.
|
||||
- Migrations: covers migrations feature of Appwrite that helps you move data around.
|
||||
- Security: purely information about measures Appwrite use to ensure security of the platform and data.
|
||||
- Self-hosting: The Appwrite self-hosted platform is meant to behave identically to Cloud after being configured corrrectly. This section focuses on how to configure Appwrite self-hosted such that it behaves like Cloud.
|
||||
- Platform: covers concepts that apply to the entire Appwrite Cloud platform, like API keys, rate limits, etc.
|
||||
- Migrations: covers migrations feature of Appwrite that helps you move data around.
|
||||
- Security: purely information about measures Appwrite use to ensure security of the platform and data.
|
||||
- Self-hosting: The Appwrite self-hosted platform is meant to behave identically to Cloud after being configured corrrectly. This section focuses on how to configure Appwrite self-hosted such that it behaves like Cloud.
|
||||
|
||||
## Documentation sources
|
||||
|
||||
@@ -117,22 +117,22 @@ The Appwrite docs are compiled from different repositories. Here are the signifi
|
||||
|
||||
[appwrite/website](https://github.com/appwrite/website):
|
||||
|
||||
- Tutorials
|
||||
- Quick starts
|
||||
- Product, API, Tooling and Advanced sections
|
||||
- Tutorials
|
||||
- Quick starts
|
||||
- Product, API, Tooling and Advanced sections
|
||||
|
||||
[appwrite/appwrite](https://github.com/appwrite/appwrite):
|
||||
|
||||
- [API Reference](https://appwrite.io/docs/references) pages
|
||||
- API specification
|
||||
- API description
|
||||
- API endpoint description
|
||||
- API request parameters
|
||||
- API response model
|
||||
- [API Reference](https://appwrite.io/docs/references) pages
|
||||
- API specification
|
||||
- API description
|
||||
- API endpoint description
|
||||
- API request parameters
|
||||
- API response model
|
||||
|
||||
[appwrite/sdk-generator](https://github.com/appwrite/sdk-generator):
|
||||
|
||||
- Generated examples
|
||||
- Generated examples
|
||||
|
||||
## Markdown Style guidelines
|
||||
|
||||
@@ -141,10 +141,10 @@ the tone and voice remains consistent.
|
||||
|
||||
### Headings
|
||||
|
||||
- All titles, headings, buttons, and labels should be written in **sentence case**. If you're not sure what sentence case should look like, check [APA's style guide](https://apastyle.apa.org/style-grammar-guidelines/capitalization/sentence-case) or check with ChatGPT and other LLMs which reliably converts titles to sentence case.
|
||||
- All headings in a docs page begin with `# Heading` then `## Heading` and `### Heading`. Internally, they're converted to H2 to H4 tags.
|
||||
- All headings should have an ID label, for example `# Cool heading {% #cool-heading %}` the `#cool-heading` ID will be used to generate the table of contents and add links to the heading.
|
||||
- Prefer verbs over gerunds, for example, say "Create documents" not "Creating documents".
|
||||
- All titles, headings, buttons, and labels should be written in **sentence case**. If you're not sure what sentence case should look like, check [APA's style guide](https://apastyle.apa.org/style-grammar-guidelines/capitalization/sentence-case) or check with ChatGPT and other LLMs which reliably converts titles to sentence case.
|
||||
- All headings in a docs page begin with `# Heading` then `## Heading` and `### Heading`. Internally, they're converted to H2 to H4 tags.
|
||||
- All headings should have an ID label, for example `# Cool heading {% #cool-heading %}` the `#cool-heading` ID will be used to generate the table of contents and add links to the heading.
|
||||
- Prefer verbs over gerunds, for example, say "Create documents" not "Creating documents".
|
||||
|
||||
### Extended Markdoc components
|
||||
|
||||
@@ -152,14 +152,14 @@ Appwrite's documentation uses extended markdown syntax. You can find all of the
|
||||
|
||||
### Screenshots
|
||||
|
||||
- When contributing upload original screenshots. The Appwrite design team will edit the screenshot to be consistent with other screenshots in the docs.
|
||||
- Screenshots must be 16:9
|
||||
- Screnshots should be taken in a 1400 x 900 view port on 3x DPR in browser developer tools.
|
||||
- Use generic and sensible organization, project, and resource names. Avoid names like `test`, `demo`, or `sdlkfj`.
|
||||
- All screenshot should be take from a user named Walter O'Brien. You can change the name of your current user by going to your Appwrite Console and clicking the **top right profile icon** > **Your Account** > **Name**.
|
||||
- Screenshots are stored in the `/images/docs/` folder, in a parent folder that is consistent with the path of the docs that reference the image.
|
||||
- All screenshots must be both dark and light mode, with `/path/` holding the lightmode version and `/path/dark/` holding the dark mode version.
|
||||
- Screenshots should be uploaded as un-edited original. Request help from the Appwrite design team to help you edit and refine your photos according to our guidelines.
|
||||
- When contributing upload original screenshots. The Appwrite design team will edit the screenshot to be consistent with other screenshots in the docs.
|
||||
- Screenshots must be 16:9
|
||||
- Screnshots should be taken in a 1400 x 900 view port on 3x DPR in browser developer tools.
|
||||
- Use generic and sensible organization, project, and resource names. Avoid names like `test`, `demo`, or `sdlkfj`.
|
||||
- All screenshot should be take from a user named Walter O'Brien. You can change the name of your current user by going to your Appwrite Console and clicking the **top right profile icon** > **Your Account** > **Name**.
|
||||
- Screenshots are stored in the `/images/docs/` folder, in a parent folder that is consistent with the path of the docs that reference the image.
|
||||
- All screenshots must be both dark and light mode, with `/path/` holding the lightmode version and `/path/dark/` holding the dark mode version.
|
||||
- Screenshots should be uploaded as un-edited original. Request help from the Appwrite design team to help you edit and refine your photos according to our guidelines.
|
||||
|
||||
```md
|
||||
{% only_dark %}
|
||||
@@ -210,41 +210,41 @@ Split content such that each piece makes sense without reading dependents or exp
|
||||
|
||||
### Release prep
|
||||
|
||||
- [ ] Add new version to [src/lib/utils/references.ts](src/lib/utils/references.ts)
|
||||
- [ ] Point Cloud to new version in [src/routes/docs/references/[version]/[platform]/[service]/+page.server.ts](src/routes/docs/references/[version]/[platform]/[service]/+page.server.ts)
|
||||
- [ ] Update install command in [/workspaces/website/src/routes/docs/advanced/self-hosting/+page.markdoc](/workspaces/website/src/routes/docs/advanced/self-hosting/+page.markdoc)
|
||||
- [ ] Update events [src/partials/[product]-events.md](src/partials/)
|
||||
- [ ] Update response code [src/routes/docs/advanced/platform/response-codes/+page.markdoc](src/routes/docs/advanced/platform/response-codes/+page.markdoc)
|
||||
- [ ] Bump latest SDK versions in SDKs page, quick start, and tutorials
|
||||
- [ ] Create new sections for new products
|
||||
- [ ] Create new concept and journey pages for new features
|
||||
- [ ] Update docs for breaking changes
|
||||
- [ ] Add new version to [src/lib/utils/references.ts](src/lib/utils/references.ts)
|
||||
- [ ] Point Cloud to new version in [src/routes/docs/references/[version]/[platform]/[service]/+page.server.ts](src/routes/docs/references/[version]/[platform]/[service]/+page.server.ts)
|
||||
- [ ] Update install command in [/workspaces/website/src/routes/docs/advanced/self-hosting/+page.markdoc](/workspaces/website/src/routes/docs/advanced/self-hosting/+page.markdoc)
|
||||
- [ ] Update events [src/partials/[product]-events.md](src/partials/)
|
||||
- [ ] Update response code [src/routes/docs/advanced/platform/response-codes/+page.markdoc](src/routes/docs/advanced/platform/response-codes/+page.markdoc)
|
||||
- [ ] Bump latest SDK versions in SDKs page, quick start, and tutorials
|
||||
- [ ] Create new sections for new products
|
||||
- [ ] Create new concept and journey pages for new features
|
||||
- [ ] Update docs for breaking changes
|
||||
|
||||
### Documenting a new API
|
||||
|
||||
- Add a new .md file describing the new API here: <https://github.com/appwrite/appwrite/tree/main/docs/references>
|
||||
- Add descriptions for methods and parameters in the controller code: <https://github.com/appwrite/appwrite/tree/main/app/controllers/api>
|
||||
- Check new response models have meaningful descriptions
|
||||
- Add a new .md file describing the new API here: <https://github.com/appwrite/appwrite/tree/main/docs/references>
|
||||
- Add descriptions for methods and parameters in the controller code: <https://github.com/appwrite/appwrite/tree/main/app/controllers/api>
|
||||
- Check new response models have meaningful descriptions
|
||||
|
||||
### Adding a new quickstart
|
||||
|
||||
- Copy a quick start from the [src/routes/docs/quick-starts](src/routes/docs/quick-starts) folder.
|
||||
- Add a new entry and logo to [src/routes/docs/quick-starts/+page.svelte](src/routes/docs/quick-starts/+page.svelte)
|
||||
- If you need a new logo, contact the Appwrite team to add one to Pink design.
|
||||
- Update the content of your tutorial. Remember to update the front matter!
|
||||
- Try to be consistent in both the quickstart's content and format when compared to existing quick starts
|
||||
- Add the quick start to the footer and front page of Appwrite
|
||||
- Use sections for steps on your page
|
||||
- Copy a quick start from the [src/routes/docs/quick-starts](src/routes/docs/quick-starts) folder.
|
||||
- Add a new entry and logo to [src/routes/docs/quick-starts/+page.svelte](src/routes/docs/quick-starts/+page.svelte)
|
||||
- If you need a new logo, contact the Appwrite team to add one to Pink design.
|
||||
- Update the content of your tutorial. Remember to update the front matter!
|
||||
- Try to be consistent in both the quickstart's content and format when compared to existing quick starts
|
||||
- Add the quick start to the footer and front page of Appwrite
|
||||
- Use sections for steps on your page
|
||||
|
||||
### Adding a new tutorial
|
||||
|
||||
- Copy a tutorial from the [src/routes/docs/tutorials](src/routes/docs/tutorials) folder.
|
||||
- Update the `+page.ts`'s redirect, for example, the Android tutorial has this: [src/routes/docs/tutorials/android/+page.ts](src/routes/docs/tutorials/android/+page.ts)
|
||||
- Update [src/routes/docs/tutorials/+page.svelte](src/routes/docs/tutorials/+page.svelte) and add your new tutorial
|
||||
- Update [src/routes/docs/tutorials/android/+layout.ts](src/routes/docs/tutorials/android/+layout.ts) and add your new tutorial
|
||||
- Add the content of your tutorial. Keep pages short, separated by a different distinct feature for each step.
|
||||
- If you need a new logo, contact the Appwrite team to add one to Pink design.
|
||||
- Add the tutorial to the footer and front page of Appwrite
|
||||
- Copy a tutorial from the [src/routes/docs/tutorials](src/routes/docs/tutorials) folder.
|
||||
- Update the `+page.ts`'s redirect, for example, the Android tutorial has this: [src/routes/docs/tutorials/android/+page.ts](src/routes/docs/tutorials/android/+page.ts)
|
||||
- Update [src/routes/docs/tutorials/+page.svelte](src/routes/docs/tutorials/+page.svelte) and add your new tutorial
|
||||
- Update [src/routes/docs/tutorials/android/+layout.ts](src/routes/docs/tutorials/android/+layout.ts) and add your new tutorial
|
||||
- Add the content of your tutorial. Keep pages short, separated by a different distinct feature for each step.
|
||||
- If you need a new logo, contact the Appwrite team to add one to Pink design.
|
||||
- Add the tutorial to the footer and front page of Appwrite
|
||||
|
||||
## Language and diction
|
||||
|
||||
|
||||
@@ -1,174 +1,174 @@
|
||||
{% table %}
|
||||
|
||||
- Name
|
||||
- Description
|
||||
- Name
|
||||
- Description
|
||||
|
||||
---
|
||||
|
||||
- `teams.*`
|
||||
- This event triggers on any teams event.
|
||||
Returns [Team Object](/docs/references/cloud/models/team)
|
||||
- `teams.*`
|
||||
- This event triggers on any teams event.
|
||||
Returns [Team Object](/docs/references/cloud/models/team)
|
||||
|
||||
---
|
||||
|
||||
- `teams.*.create`
|
||||
- This event triggers when a team is created.
|
||||
Returns [Team Object](/docs/references/cloud/models/team)
|
||||
- `teams.*.create`
|
||||
- This event triggers when a team is created.
|
||||
Returns [Team Object](/docs/references/cloud/models/team)
|
||||
|
||||
---
|
||||
|
||||
- `teams.*.delete`
|
||||
- This event triggers when a team is deleted.
|
||||
Returns [Team Object](/docs/references/cloud/models/team)
|
||||
- `teams.*.delete`
|
||||
- This event triggers when a team is deleted.
|
||||
Returns [Team Object](/docs/references/cloud/models/team)
|
||||
|
||||
---
|
||||
|
||||
- `teams.*.memberships.*`
|
||||
- This event triggers on any team memberships event.
|
||||
Returns [Membership Object](/docs/references/cloud/models/membership)
|
||||
- `teams.*.memberships.*`
|
||||
- This event triggers on any team memberships event.
|
||||
Returns [Membership Object](/docs/references/cloud/models/membership)
|
||||
|
||||
---
|
||||
|
||||
- `teams.*.memberships.*.create`
|
||||
- This event triggers when a membership is created.
|
||||
Returns [Membership Object](/docs/references/cloud/models/membership)
|
||||
- `teams.*.memberships.*.create`
|
||||
- This event triggers when a membership is created.
|
||||
Returns [Membership Object](/docs/references/cloud/models/membership)
|
||||
|
||||
---
|
||||
|
||||
- `teams.*.memberships.*.delete`
|
||||
- This event triggers when a membership is deleted.
|
||||
Returns [Membership Object](/docs/references/cloud/models/membership)
|
||||
- `teams.*.memberships.*.delete`
|
||||
- This event triggers when a membership is deleted.
|
||||
Returns [Membership Object](/docs/references/cloud/models/membership)
|
||||
|
||||
---
|
||||
|
||||
- `teams.*.memberships.*.update`
|
||||
- This event triggers when a membership is updated.
|
||||
Returns [Membership Object](/docs/references/cloud/models/membership)
|
||||
- `teams.*.memberships.*.update`
|
||||
- This event triggers when a membership is updated.
|
||||
Returns [Membership Object](/docs/references/cloud/models/membership)
|
||||
|
||||
---
|
||||
|
||||
- `teams.*.memberships.*.update.status`
|
||||
- This event triggers when a team memberships status is updated.
|
||||
Returns [Membership Object](/docs/references/cloud/models/membership)
|
||||
- `teams.*.memberships.*.update.status`
|
||||
- This event triggers when a team memberships status is updated.
|
||||
Returns [Membership Object](/docs/references/cloud/models/membership)
|
||||
|
||||
---
|
||||
|
||||
- `teams.*.update`
|
||||
- This event triggers when a team is updated.
|
||||
Returns [Team Object](/docs/references/cloud/models/team)
|
||||
- `teams.*.update`
|
||||
- This event triggers when a team is updated.
|
||||
Returns [Team Object](/docs/references/cloud/models/team)
|
||||
|
||||
---
|
||||
|
||||
- `teams.*.update.prefs`
|
||||
- This event triggers when a team's preferences are updated.
|
||||
Returns [Team Object](/docs/references/cloud/models/team)
|
||||
- `teams.*.update.prefs`
|
||||
- This event triggers when a team's preferences are updated.
|
||||
Returns [Team Object](/docs/references/cloud/models/team)
|
||||
|
||||
---
|
||||
|
||||
- `users.*`
|
||||
- This event triggers on any user's event.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
- `users.*`
|
||||
- This event triggers on any user's event.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.create`
|
||||
- This event triggers when a user is created.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
- `users.*.create`
|
||||
- This event triggers when a user is created.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.delete`
|
||||
- This event triggers when a user is deleted.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
- `users.*.delete`
|
||||
- This event triggers when a user is deleted.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.recovery.*`
|
||||
- This event triggers on any user's recovery token event.
|
||||
Returns [Token Object](/docs/references/cloud/models/token)
|
||||
- `users.*.recovery.*`
|
||||
- This event triggers on any user's recovery token event.
|
||||
Returns [Token Object](/docs/references/cloud/models/token)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.recovery.*.create`
|
||||
- This event triggers when a recovery token for a user is created.
|
||||
Returns [Token Object](/docs/references/cloud/models/token)
|
||||
- `users.*.recovery.*.create`
|
||||
- This event triggers when a recovery token for a user is created.
|
||||
Returns [Token Object](/docs/references/cloud/models/token)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.recovery.*.update`
|
||||
- This event triggers when a recovery token for a user is validated.
|
||||
Returns [Token Object](/docs/references/cloud/models/token)
|
||||
- `users.*.recovery.*.update`
|
||||
- This event triggers when a recovery token for a user is validated.
|
||||
Returns [Token Object](/docs/references/cloud/models/token)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.sessions.*`
|
||||
- This event triggers on any user's sessions event.
|
||||
Returns [Session Object](/docs/references/cloud/models/session)
|
||||
- `users.*.sessions.*`
|
||||
- This event triggers on any user's sessions event.
|
||||
Returns [Session Object](/docs/references/cloud/models/session)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.sessions.*.create`
|
||||
- This event triggers when a session for a user is created.
|
||||
Returns [Session Object](/docs/references/cloud/models/session)
|
||||
- `users.*.sessions.*.create`
|
||||
- This event triggers when a session for a user is created.
|
||||
Returns [Session Object](/docs/references/cloud/models/session)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.sessions.*.delete`
|
||||
- This event triggers when a session for a user is deleted.
|
||||
Returns [Session Object](/docs/references/cloud/models/session)
|
||||
- `users.*.sessions.*.delete`
|
||||
- This event triggers when a session for a user is deleted.
|
||||
Returns [Session Object](/docs/references/cloud/models/session)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.update`
|
||||
- This event triggers when a user is updated.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
- `users.*.update`
|
||||
- This event triggers when a user is updated.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.update.email`
|
||||
- This event triggers when a user's email address is updated.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
- `users.*.update.email`
|
||||
- This event triggers when a user's email address is updated.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.update.name`
|
||||
- This event triggers when a user's name is updated.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
- `users.*.update.name`
|
||||
- This event triggers when a user's name is updated.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.update.password`
|
||||
- This event triggers when a user's password is updated.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
- `users.*.update.password`
|
||||
- This event triggers when a user's password is updated.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.update.prefs`
|
||||
- This event triggers when a user's preferences is updated.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
- `users.*.update.prefs`
|
||||
- This event triggers when a user's preferences is updated.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.update.status`
|
||||
- This event triggers when a user's status is updated.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
- `users.*.update.status`
|
||||
- This event triggers when a user's status is updated.
|
||||
Returns [User Object](/docs/references/cloud/models/user)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.verification.*`
|
||||
- This event triggers on any user's verification token event.
|
||||
Returns [Token Object](/docs/references/cloud/models/token)
|
||||
- `users.*.verification.*`
|
||||
- This event triggers on any user's verification token event.
|
||||
Returns [Token Object](/docs/references/cloud/models/token)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.verification.*.create`
|
||||
- This event triggers when a verification token for a user is created.
|
||||
Returns [Token Object](/docs/references/cloud/models/token)
|
||||
- `users.*.verification.*.create`
|
||||
- This event triggers when a verification token for a user is created.
|
||||
Returns [Token Object](/docs/references/cloud/models/token)
|
||||
|
||||
---
|
||||
|
||||
- `users.*.verification.*.update`
|
||||
- This event triggers when a verification token for a user is validated.
|
||||
Returns [Token Object](/docs/references/cloud/models/token)
|
||||
- `users.*.verification.*.update`
|
||||
- This event triggers when a verification token for a user is validated.
|
||||
Returns [Token Object](/docs/references/cloud/models/token)
|
||||
|
||||
{% /table %}
|
||||
|
||||
@@ -69,9 +69,9 @@ In certain use cases, your app may not need to share members' personal informati
|
||||
|
||||
These details can be made private:
|
||||
|
||||
- `userName` - The member's name
|
||||
- `userEmail` - The member's email address
|
||||
- `mfa` - Whether the member has enabled multi-factor authentication
|
||||
- `userName` - The member's name
|
||||
- `userEmail` - The member's email address
|
||||
- `mfa` - Whether the member has enabled multi-factor authentication
|
||||
|
||||
# Mock phone numbers {% #mock-phone-numbers %}
|
||||
|
||||
|
||||
@@ -1,112 +1,112 @@
|
||||
{% table %}
|
||||
|
||||
- Name
|
||||
- Description
|
||||
- Name
|
||||
- Description
|
||||
|
||||
---
|
||||
|
||||
- `databases.*`
|
||||
- This event triggers on any database event.
|
||||
Returns [Database Object](/docs/references/cloud/models/database)
|
||||
- `databases.*`
|
||||
- This event triggers on any database event.
|
||||
Returns [Database Object](/docs/references/cloud/models/database)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.collections.*`
|
||||
- This event triggers on any collection event.
|
||||
Returns [Collection Object](/docs/references/cloud/models/collection)
|
||||
- `databases.*.collections.*`
|
||||
- This event triggers on any collection event.
|
||||
Returns [Collection Object](/docs/references/cloud/models/collection)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.collections.*.attributes.*`
|
||||
- This event triggers on any attributes event.
|
||||
Returns [Attribute Object](/docs/references/cloud/models/attributeList)
|
||||
- `databases.*.collections.*.attributes.*`
|
||||
- This event triggers on any attributes event.
|
||||
Returns [Attribute Object](/docs/references/cloud/models/attributeList)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.collections.*.attributes.*.create`
|
||||
- This event triggers when an attribute is created.
|
||||
Returns [Attribute Object](/docs/references/cloud/models/attributeList)
|
||||
- `databases.*.collections.*.attributes.*.create`
|
||||
- This event triggers when an attribute is created.
|
||||
Returns [Attribute Object](/docs/references/cloud/models/attributeList)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.collections.*.attributes.*.delete`
|
||||
- This event triggers when an attribute is deleted.
|
||||
Returns [Attribute Object](/docs/references/cloud/models/attributeList)
|
||||
- `databases.*.collections.*.attributes.*.delete`
|
||||
- This event triggers when an attribute is deleted.
|
||||
Returns [Attribute Object](/docs/references/cloud/models/attributeList)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.collections.*.create`
|
||||
- This event triggers when a collection is created.
|
||||
Returns [Collection Object](/docs/references/cloud/models/collection)
|
||||
- `databases.*.collections.*.create`
|
||||
- This event triggers when a collection is created.
|
||||
Returns [Collection Object](/docs/references/cloud/models/collection)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.collections.*.delete`
|
||||
- This event triggers when a collection is deleted.
|
||||
Returns [Collection Object](/docs/references/cloud/models/collection)
|
||||
- `databases.*.collections.*.delete`
|
||||
- This event triggers when a collection is deleted.
|
||||
Returns [Collection Object](/docs/references/cloud/models/collection)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.collections.*.documents.*`
|
||||
- This event triggers on any documents event.
|
||||
Returns [Document Object](/docs/references/cloud/models/document)
|
||||
- `databases.*.collections.*.documents.*`
|
||||
- This event triggers on any documents event.
|
||||
Returns [Document Object](/docs/references/cloud/models/document)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.collections.*.documents.*.create`
|
||||
- This event triggers when a document is created.
|
||||
Returns [Document Object](/docs/references/cloud/models/document)
|
||||
- `databases.*.collections.*.documents.*.create`
|
||||
- This event triggers when a document is created.
|
||||
Returns [Document Object](/docs/references/cloud/models/document)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.collections.*.documents.*.delete`
|
||||
- This event triggers when a document is deleted.
|
||||
Returns [Document Object](/docs/references/cloud/models/document)
|
||||
- `databases.*.collections.*.documents.*.delete`
|
||||
- This event triggers when a document is deleted.
|
||||
Returns [Document Object](/docs/references/cloud/models/document)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.collections.*.documents.*.update`
|
||||
- This event triggers when a document is updated.
|
||||
Returns [Document Object](/docs/references/cloud/models/document)
|
||||
- `databases.*.collections.*.documents.*.update`
|
||||
- This event triggers when a document is updated.
|
||||
Returns [Document Object](/docs/references/cloud/models/document)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.collections.*.indexes.*`
|
||||
- This event triggers on any indexes event.
|
||||
Returns [Index Object](/docs/references/cloud/models/index)
|
||||
- `databases.*.collections.*.indexes.*`
|
||||
- This event triggers on any indexes event.
|
||||
Returns [Index Object](/docs/references/cloud/models/index)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.collections.*.indexes.*.create`
|
||||
- This event triggers when an index is created.
|
||||
Returns [Index Object](/docs/references/cloud/models/index)
|
||||
- `databases.*.collections.*.indexes.*.create`
|
||||
- This event triggers when an index is created.
|
||||
Returns [Index Object](/docs/references/cloud/models/index)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.collections.*.indexes.*.delete`
|
||||
- This event triggers when an index is deleted.
|
||||
Returns [Index Object](/docs/references/cloud/models/index)
|
||||
- `databases.*.collections.*.indexes.*.delete`
|
||||
- This event triggers when an index is deleted.
|
||||
Returns [Index Object](/docs/references/cloud/models/index)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.collections.*.update`
|
||||
- This event triggers when a collection is updated.
|
||||
Returns [Collection Object](/docs/references/cloud/models/collection)
|
||||
- `databases.*.collections.*.update`
|
||||
- This event triggers when a collection is updated.
|
||||
Returns [Collection Object](/docs/references/cloud/models/collection)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.create`
|
||||
- This event triggers when a database is created.
|
||||
Returns [Database Object](/docs/references/cloud/models/database)
|
||||
- `databases.*.create`
|
||||
- This event triggers when a database is created.
|
||||
Returns [Database Object](/docs/references/cloud/models/database)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.delete`
|
||||
- This event triggers when a database is deleted.
|
||||
Returns [Database Object](/docs/references/cloud/models/database)
|
||||
- `databases.*.delete`
|
||||
- This event triggers when a database is deleted.
|
||||
Returns [Database Object](/docs/references/cloud/models/database)
|
||||
|
||||
---
|
||||
|
||||
- `databases.*.update`
|
||||
- This event triggers when a database is updated.
|
||||
Returns [Database Object](/docs/references/cloud/models/database){% /table %}
|
||||
- `databases.*.update`
|
||||
- This event triggers when a database is updated.
|
||||
Returns [Database Object](/docs/references/cloud/models/database){% /table %}
|
||||
|
||||
@@ -1,78 +1,78 @@
|
||||
{% table %}
|
||||
|
||||
- Name
|
||||
- Description
|
||||
- Name
|
||||
- Description
|
||||
|
||||
---
|
||||
|
||||
- `functions.*`
|
||||
- This event triggers on any functions event.
|
||||
Returns [Function Object](/docs/references/cloud/models/function)
|
||||
- `functions.*`
|
||||
- This event triggers on any functions event.
|
||||
Returns [Function Object](/docs/references/cloud/models/function)
|
||||
|
||||
---
|
||||
|
||||
- `functions.*.create`
|
||||
- This event triggers when a function is created.
|
||||
Returns [Function Object](/docs/references/cloud/models/function)
|
||||
- `functions.*.create`
|
||||
- This event triggers when a function is created.
|
||||
Returns [Function Object](/docs/references/cloud/models/function)
|
||||
|
||||
---
|
||||
|
||||
- `functions.*.delete`
|
||||
- This event triggers when a function is deleted.
|
||||
Returns [Function Object](/docs/references/cloud/models/function)
|
||||
- `functions.*.delete`
|
||||
- This event triggers when a function is deleted.
|
||||
Returns [Function Object](/docs/references/cloud/models/function)
|
||||
|
||||
---
|
||||
|
||||
- `functions.*.deployments.*`
|
||||
- This event triggers on any deployments event.
|
||||
Returns [Deployment Object](/docs/references/cloud/models/deployment)
|
||||
- `functions.*.deployments.*`
|
||||
- This event triggers on any deployments event.
|
||||
Returns [Deployment Object](/docs/references/cloud/models/deployment)
|
||||
|
||||
---
|
||||
|
||||
- `functions.*.deployments.*.create`
|
||||
- This event triggers when a deployment is created.
|
||||
Returns [Deployment Object](/docs/references/cloud/models/deployment)
|
||||
- `functions.*.deployments.*.create`
|
||||
- This event triggers when a deployment is created.
|
||||
Returns [Deployment Object](/docs/references/cloud/models/deployment)
|
||||
|
||||
---
|
||||
|
||||
- `functions.*.deployments.*.delete`
|
||||
- This event triggers when a deployment is deleted.
|
||||
Returns [Deployment Object](/docs/references/cloud/models/deployment)
|
||||
- `functions.*.deployments.*.delete`
|
||||
- This event triggers when a deployment is deleted.
|
||||
Returns [Deployment Object](/docs/references/cloud/models/deployment)
|
||||
|
||||
---
|
||||
|
||||
- `functions.*.deployments.*.update`
|
||||
- This event triggers when a deployment is updated.
|
||||
Returns [Deployment Object](/docs/references/cloud/models/deployment)
|
||||
- `functions.*.deployments.*.update`
|
||||
- This event triggers when a deployment is updated.
|
||||
Returns [Deployment Object](/docs/references/cloud/models/deployment)
|
||||
|
||||
---
|
||||
|
||||
- `functions.*.executions.*`
|
||||
- This event triggers on any executions event.
|
||||
Returns [Execution Object](/docs/references/cloud/models/execution)
|
||||
- `functions.*.executions.*`
|
||||
- This event triggers on any executions event.
|
||||
Returns [Execution Object](/docs/references/cloud/models/execution)
|
||||
|
||||
---
|
||||
|
||||
- `functions.*.executions.*.create`
|
||||
- This event triggers when an execution is created.
|
||||
Returns [Execution Object](/docs/references/cloud/models/execution)
|
||||
- `functions.*.executions.*.create`
|
||||
- This event triggers when an execution is created.
|
||||
Returns [Execution Object](/docs/references/cloud/models/execution)
|
||||
|
||||
---
|
||||
|
||||
- `functions.*.executions.*.delete`
|
||||
- This event triggers when an execution is deleted.
|
||||
Returns [Execution Object](/docs/references/cloud/models/execution)
|
||||
- `functions.*.executions.*.delete`
|
||||
- This event triggers when an execution is deleted.
|
||||
Returns [Execution Object](/docs/references/cloud/models/execution)
|
||||
|
||||
---
|
||||
|
||||
- `functions.*.executions.*.update`
|
||||
- This event triggers when an execution is updated.
|
||||
Returns [Execution Object](/docs/references/cloud/models/execution)
|
||||
- `functions.*.executions.*.update`
|
||||
- This event triggers when an execution is updated.
|
||||
Returns [Execution Object](/docs/references/cloud/models/execution)
|
||||
|
||||
---
|
||||
|
||||
- `functions.*.update`
|
||||
- This event triggers when a function is updated.
|
||||
Returns [Function Object](/docs/references/cloud/models/function)
|
||||
- `functions.*.update`
|
||||
- This event triggers when a function is updated.
|
||||
Returns [Function Object](/docs/references/cloud/models/function)
|
||||
|
||||
{% /table %}
|
||||
|
||||
@@ -1,90 +1,90 @@
|
||||
{% table %}
|
||||
|
||||
- Name
|
||||
- Description
|
||||
- Name
|
||||
- Description
|
||||
|
||||
---
|
||||
|
||||
- `providers.*`
|
||||
- This event triggers on any providers event.
|
||||
Returns [Provider Object](/docs/references/cloud/models/provider)
|
||||
- `providers.*`
|
||||
- This event triggers on any providers event.
|
||||
Returns [Provider Object](/docs/references/cloud/models/provider)
|
||||
|
||||
---
|
||||
|
||||
- `providers.*.create`
|
||||
- This event triggers when a provider is created.
|
||||
Returns [Provider Object](/docs/references/cloud/models/provider)
|
||||
- `providers.*.create`
|
||||
- This event triggers when a provider is created.
|
||||
Returns [Provider Object](/docs/references/cloud/models/provider)
|
||||
|
||||
---
|
||||
|
||||
- `providers.*.delete`
|
||||
- This event triggers when a provider is deleted.
|
||||
Returns [Provider Object](/docs/references/cloud/models/provider)
|
||||
- `providers.*.delete`
|
||||
- This event triggers when a provider is deleted.
|
||||
Returns [Provider Object](/docs/references/cloud/models/provider)
|
||||
|
||||
---
|
||||
|
||||
- `providers.*.update`
|
||||
- This event triggers when a provider is updated.
|
||||
Returns [Provider Object](/docs/references/cloud/models/provider)
|
||||
- `providers.*.update`
|
||||
- This event triggers when a provider is updated.
|
||||
Returns [Provider Object](/docs/references/cloud/models/provider)
|
||||
|
||||
---
|
||||
|
||||
- `topics.*`
|
||||
- This event triggers on any topic event.
|
||||
Returns [Topic Object](/docs/references/cloud/models/topic)
|
||||
- `topics.*`
|
||||
- This event triggers on any topic event.
|
||||
Returns [Topic Object](/docs/references/cloud/models/topic)
|
||||
|
||||
---
|
||||
|
||||
- `topics.*.create`
|
||||
- This event triggers when a topic is created.
|
||||
Returns [Topic Object](/docs/references/cloud/models/topic)
|
||||
- `topics.*.create`
|
||||
- This event triggers when a topic is created.
|
||||
Returns [Topic Object](/docs/references/cloud/models/topic)
|
||||
|
||||
---
|
||||
|
||||
- `topics.*.delete`
|
||||
- This event triggers when a topic is deleted.
|
||||
Returns [Topic Object](/docs/references/cloud/models/topic)
|
||||
- `topics.*.delete`
|
||||
- This event triggers when a topic is deleted.
|
||||
Returns [Topic Object](/docs/references/cloud/models/topic)
|
||||
|
||||
---
|
||||
|
||||
- `topics.*.update`
|
||||
- This event triggers when a topic is updated.
|
||||
Returns [Topic Object](/docs/references/cloud/models/topic)
|
||||
- `topics.*.update`
|
||||
- This event triggers when a topic is updated.
|
||||
Returns [Topic Object](/docs/references/cloud/models/topic)
|
||||
|
||||
---
|
||||
|
||||
- `topics.*.subscribers.*.create`
|
||||
- This event triggers when a subscriber to a topic is created.
|
||||
Returns [Topic Object](/docs/references/cloud/models/topic)
|
||||
- `topics.*.subscribers.*.create`
|
||||
- This event triggers when a subscriber to a topic is created.
|
||||
Returns [Topic Object](/docs/references/cloud/models/topic)
|
||||
|
||||
---
|
||||
|
||||
- `topics.*.subscribers.*.delete`
|
||||
- This event triggers when a subscriber to a topic is deleted.
|
||||
Returns [Topic Object](/docs/references/cloud/models/topic)
|
||||
- `topics.*.subscribers.*.delete`
|
||||
- This event triggers when a subscriber to a topic is deleted.
|
||||
Returns [Topic Object](/docs/references/cloud/models/topic)
|
||||
|
||||
---
|
||||
|
||||
- `messages.*`
|
||||
- This event triggers on any message event.
|
||||
Returns [Message Object](/docs/references/cloud/models/message)
|
||||
- `messages.*`
|
||||
- This event triggers on any message event.
|
||||
Returns [Message Object](/docs/references/cloud/models/message)
|
||||
|
||||
---
|
||||
|
||||
- `messages.*.create`
|
||||
- This event triggers when a message is created.
|
||||
Returns [Message Object](/docs/references/cloud/models/message)
|
||||
- `messages.*.create`
|
||||
- This event triggers when a message is created.
|
||||
Returns [Message Object](/docs/references/cloud/models/message)
|
||||
|
||||
---
|
||||
|
||||
- `messages.*.delete`
|
||||
- This event triggers when a message is deleted.
|
||||
Returns [Message Object](/docs/references/cloud/models/message)
|
||||
- `messages.*.delete`
|
||||
- This event triggers when a message is deleted.
|
||||
Returns [Message Object](/docs/references/cloud/models/message)
|
||||
|
||||
---
|
||||
|
||||
- `messages.*.update`
|
||||
- This event triggers when a message is updated.
|
||||
Returns [Message Object](/docs/references/cloud/models/message)
|
||||
- `messages.*.update`
|
||||
- This event triggers when a message is updated.
|
||||
Returns [Message Object](/docs/references/cloud/models/message)
|
||||
|
||||
{% /table %}
|
||||
|
||||
@@ -2,18 +2,18 @@
|
||||
|
||||
The following actions are prohibited on the Appwrite platform and may lead to immediate suspension or termination:
|
||||
|
||||
- **Illegal and harmful content:** Sharing any content that is illegal, infringing (e.g., copyright infringement), harmful, threatening, defamatory, obscene, harassing, or otherwise objectionable. This includes distributing malware, viruses, or any malicious code.
|
||||
- **Unauthorized access and disruption:** Accessing or attempting to access any system, data, or account without authorization. This includes:
|
||||
- Hacking
|
||||
- Penetration testing without approval
|
||||
- Denial-of-Service (DoS) attacks
|
||||
- Disrupting Appwrite Cloud's integrity or performance (e.g., excessive resource usage, unauthorized load testing)
|
||||
- **Deceptive practices:** Engaging in any fraudulent or deceptive activity, such as:
|
||||
- Phishing
|
||||
- Misleading others
|
||||
- Circumventing payment obligations
|
||||
- **Unsolicited communications:** Sending spam, unauthorized advertising, or any form of improper solicitation.
|
||||
- **Misuse of resources:**
|
||||
- Using Appwrite Cloud for cryptocurrency mining without authorization
|
||||
- Violating any applicable laws or regulations
|
||||
- Using the Education plan for non-educational or commercial purposes
|
||||
- **Illegal and harmful content:** Sharing any content that is illegal, infringing (e.g., copyright infringement), harmful, threatening, defamatory, obscene, harassing, or otherwise objectionable. This includes distributing malware, viruses, or any malicious code.
|
||||
- **Unauthorized access and disruption:** Accessing or attempting to access any system, data, or account without authorization. This includes:
|
||||
- Hacking
|
||||
- Penetration testing without approval
|
||||
- Denial-of-Service (DoS) attacks
|
||||
- Disrupting Appwrite Cloud's integrity or performance (e.g., excessive resource usage, unauthorized load testing)
|
||||
- **Deceptive practices:** Engaging in any fraudulent or deceptive activity, such as:
|
||||
- Phishing
|
||||
- Misleading others
|
||||
- Circumventing payment obligations
|
||||
- **Unsolicited communications:** Sending spam, unauthorized advertising, or any form of improper solicitation.
|
||||
- **Misuse of resources:**
|
||||
- Using Appwrite Cloud for cryptocurrency mining without authorization
|
||||
- Violating any applicable laws or regulations
|
||||
- Using the Education plan for non-educational or commercial purposes
|
||||
|
||||
@@ -7,41 +7,41 @@ You can check your organization's resource usage for the current billing cycle b
|
||||
Reaching your organization's resource limits will have the following effects until the current billing period ends.
|
||||
{% table %}
|
||||
|
||||
- Component
|
||||
- Consequence
|
||||
- Component
|
||||
- Consequence
|
||||
|
||||
---
|
||||
|
||||
- **Bandwidth** {% rowspan=3 %}
|
||||
- More bandwidth will be purchased automatically until your organization reaches a budget cap. If the organization uses a Free plan or a budget cap is reached, API access will be denied until your organization's plan is upgraded or your budget cap is increased.
|
||||
- **Bandwidth** {% rowspan=3 %}
|
||||
- More bandwidth will be purchased automatically until your organization reaches a budget cap. If the organization uses a Free plan or a budget cap is reached, API access will be denied until your organization's plan is upgraded or your budget cap is increased.
|
||||
|
||||
---
|
||||
|
||||
- Importing projects via migrations disabled, but you can still export your projects.
|
||||
- Importing projects via migrations disabled, but you can still export your projects.
|
||||
|
||||
---
|
||||
|
||||
- Platform creation disabled.
|
||||
- Platform creation disabled.
|
||||
|
||||
---
|
||||
|
||||
- **Users**
|
||||
- Creating new accounts and team invitations disabled.
|
||||
- **Users**
|
||||
- Creating new accounts and team invitations disabled.
|
||||
|
||||
---
|
||||
|
||||
- **Compute**
|
||||
- Function executions are disabled.
|
||||
- **Compute**
|
||||
- Function executions are disabled.
|
||||
|
||||
---
|
||||
|
||||
- **Realtime**
|
||||
- Realtime subscriptions disabled.
|
||||
- **Realtime**
|
||||
- Realtime subscriptions disabled.
|
||||
|
||||
---
|
||||
|
||||
- **Storage**
|
||||
- File uploads are disabled. Persists across billing periods until the amount of storage used is below the plan limit.
|
||||
- **Storage**
|
||||
- File uploads are disabled. Persists across billing periods until the amount of storage used is below the plan limit.
|
||||
|
||||
{% /table %}
|
||||
|
||||
@@ -55,37 +55,37 @@ The following consequences should also apply at the project level if the Free pl
|
||||
|
||||
{% table %}
|
||||
|
||||
- Component
|
||||
- Action
|
||||
- Component
|
||||
- Action
|
||||
|
||||
---
|
||||
|
||||
- **Platforms**
|
||||
- If more than 3 platforms have been created, disable them in order of date created (oldest ones first).
|
||||
- **Platforms**
|
||||
- If more than 3 platforms have been created, disable them in order of date created (oldest ones first).
|
||||
|
||||
---
|
||||
|
||||
- **Webhooks**
|
||||
- If more than 2 webhooks have been created, disable them in order of date created (oldest ones first).
|
||||
- **Webhooks**
|
||||
- If more than 2 webhooks have been created, disable them in order of date created (oldest ones first).
|
||||
|
||||
---
|
||||
|
||||
- **Teams**
|
||||
- If more than 100 teams have been created, disable them in order of date created (oldest ones first).
|
||||
- **Teams**
|
||||
- If more than 100 teams have been created, disable them in order of date created (oldest ones first).
|
||||
|
||||
---
|
||||
|
||||
- **Databases**
|
||||
- If more than 1 database has been created, disable them in order of date created (oldest ones first).
|
||||
- **Databases**
|
||||
- If more than 1 database has been created, disable them in order of date created (oldest ones first).
|
||||
|
||||
---
|
||||
|
||||
- **Buckets**
|
||||
- If more than 3 buckets have been created, disable them in order of date created (oldest ones first).
|
||||
- **Buckets**
|
||||
- If more than 3 buckets have been created, disable them in order of date created (oldest ones first).
|
||||
|
||||
---
|
||||
|
||||
- **Functions**
|
||||
- If more than 5 functions have been created, disable them in order of date created (oldest ones first).
|
||||
- **Functions**
|
||||
- If more than 5 functions have been created, disable them in order of date created (oldest ones first).
|
||||
|
||||
{% /table %}
|
||||
|
||||
@@ -1,54 +1,54 @@
|
||||
{% table %}
|
||||
|
||||
- Name
|
||||
- Description
|
||||
- Name
|
||||
- Description
|
||||
|
||||
---
|
||||
|
||||
- `buckets.*`
|
||||
- This event triggers on any buckets event.
|
||||
Returns [Bucket Object](/docs/references/cloud/models/bucket)
|
||||
- `buckets.*`
|
||||
- This event triggers on any buckets event.
|
||||
Returns [Bucket Object](/docs/references/cloud/models/bucket)
|
||||
|
||||
---
|
||||
|
||||
- `buckets.*.create`
|
||||
- This event triggers when a bucket is created.
|
||||
Returns [Bucket Object](/docs/references/cloud/models/bucket)
|
||||
- `buckets.*.create`
|
||||
- This event triggers when a bucket is created.
|
||||
Returns [Bucket Object](/docs/references/cloud/models/bucket)
|
||||
|
||||
---
|
||||
|
||||
- `buckets.*.delete`
|
||||
- This event triggers when a bucket is deleted.
|
||||
Returns [Bucket Object](/docs/references/cloud/models/bucket)
|
||||
- `buckets.*.delete`
|
||||
- This event triggers when a bucket is deleted.
|
||||
Returns [Bucket Object](/docs/references/cloud/models/bucket)
|
||||
|
||||
---
|
||||
|
||||
- `buckets.*.files.*`
|
||||
- This event triggers on any files event.
|
||||
Returns [File Object](/docs/references/cloud/models/file)
|
||||
- `buckets.*.files.*`
|
||||
- This event triggers on any files event.
|
||||
Returns [File Object](/docs/references/cloud/models/file)
|
||||
|
||||
---
|
||||
|
||||
- `buckets.*.files.*.create`
|
||||
- Since the Appwrite SDK chunks files in 5MB increments, this event will trigger for each 5MB chunk. A file is fully uploaded when `chunksTotal` equals `chunksUploaded`.
|
||||
Returns [File Object](/docs/references/cloud/models/file)
|
||||
- `buckets.*.files.*.create`
|
||||
- Since the Appwrite SDK chunks files in 5MB increments, this event will trigger for each 5MB chunk. A file is fully uploaded when `chunksTotal` equals `chunksUploaded`.
|
||||
Returns [File Object](/docs/references/cloud/models/file)
|
||||
|
||||
---
|
||||
|
||||
- `buckets.*.files.*.delete`
|
||||
- This event triggers when a file is deleted.
|
||||
Returns [File Object](/docs/references/cloud/models/file)
|
||||
- `buckets.*.files.*.delete`
|
||||
- This event triggers when a file is deleted.
|
||||
Returns [File Object](/docs/references/cloud/models/file)
|
||||
|
||||
---
|
||||
|
||||
- `buckets.*.files.*.update`
|
||||
- This event triggers when a file is updated.
|
||||
Returns [File Object](/docs/references/cloud/models/file)
|
||||
- `buckets.*.files.*.update`
|
||||
- This event triggers when a file is updated.
|
||||
Returns [File Object](/docs/references/cloud/models/file)
|
||||
|
||||
---
|
||||
|
||||
- `buckets.*.update`
|
||||
- This event triggers when a bucket is updated.
|
||||
Returns [Bucket Object](/docs/references/cloud/models/bucket)
|
||||
- `buckets.*.update`
|
||||
- This event triggers when a bucket is updated.
|
||||
Returns [Bucket Object](/docs/references/cloud/models/bucket)
|
||||
|
||||
{% /table %}
|
||||
|
||||
@@ -11,7 +11,8 @@
|
||||
import Copy from './Copy.svelte';
|
||||
|
||||
const title = 'Assets' + TITLE_SUFFIX;
|
||||
const description = "This page features Appwrite's key brand assets including the logotype, colors, product visuals, and practical guidelines for their usage.";
|
||||
const description =
|
||||
"This page features Appwrite's key brand assets including the logotype, colors, product visuals, and practical guidelines for their usage.";
|
||||
const ogImage = DEFAULT_HOST + '/images/open-graph/website.png';
|
||||
|
||||
enum Section {
|
||||
|
||||
@@ -13,7 +13,8 @@
|
||||
|
||||
const seo = {
|
||||
title: 'Changelog' + TITLE_SUFFIX,
|
||||
description: "Explore Appwrite's changelog to stay on top of all the product updates and track our journey.",
|
||||
description:
|
||||
"Explore Appwrite's changelog to stay on top of all the product updates and track our journey.",
|
||||
ogImage: `${DEFAULT_HOST}/images/open-graph/website.png`
|
||||
};
|
||||
|
||||
|
||||
@@ -6,7 +6,8 @@
|
||||
import { DEFAULT_DESCRIPTION, DEFAULT_HOST } from '$lib/utils/metadata';
|
||||
|
||||
const title = 'Company' + TITLE_SUFFIX;
|
||||
const description = "At Appwrite, we aim to remove technical barriers with our backend solutions. Click here to learn more about our organization, its mission and goals.";
|
||||
const description =
|
||||
'At Appwrite, we aim to remove technical barriers with our backend solutions. Click here to learn more about our organization, its mission and goals.';
|
||||
const ogImage = DEFAULT_HOST + '/images/open-graph/website.png';
|
||||
</script>
|
||||
|
||||
|
||||
@@ -39,7 +39,8 @@
|
||||
}
|
||||
|
||||
const title = 'Contact us' + TITLE_SUFFIX;
|
||||
const description = "Fill in this short form to get in touch with the Appwrite team. Questions, feature requests or bug reports - all input is welcome!";
|
||||
const description =
|
||||
'Fill in this short form to get in touch with the Appwrite team. Questions, feature requests or bug reports - all input is welcome!';
|
||||
const ogImage = DEFAULT_HOST + '/images/open-graph/website.png';
|
||||
</script>
|
||||
|
||||
|
||||
@@ -51,7 +51,8 @@
|
||||
}
|
||||
|
||||
const title = 'Enterprise' + TITLE_SUFFIX;
|
||||
const description = "Want to learn more about Appwrite's Enterprise plan? Send us a message, and we'll propose a pricing solution that fits your unique use case.";
|
||||
const description =
|
||||
"Want to learn more about Appwrite's Enterprise plan? Send us a message, and we'll propose a pricing solution that fits your unique use case.";
|
||||
const ogImage = DEFAULT_HOST + '/images/open-graph/website.png';
|
||||
</script>
|
||||
|
||||
|
||||
@@ -9,8 +9,8 @@
|
||||
</h2>
|
||||
<p class="text-secondary text-pretty">
|
||||
Join a growing community of developers and students who use Appwrite to build their
|
||||
products. Gain access to a wealth of knowledge, support, and shared experiences
|
||||
needed to grow and advance your tech career.
|
||||
products. Gain access to a wealth of knowledge, support, and shared experiences needed
|
||||
to grow and advance your tech career.
|
||||
</p>
|
||||
<a
|
||||
href="/discord"
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
},
|
||||
{
|
||||
question: 'Who is eligible to apply?',
|
||||
answer: 'Any student enrolled in the GitHub Student Developer Pack can apply for free and receive Appwrite\'s Education plan until graduation.'
|
||||
answer: "Any student enrolled in the GitHub Student Developer Pack can apply for free and receive Appwrite's Education plan until graduation."
|
||||
},
|
||||
{
|
||||
question: 'How do I apply?',
|
||||
|
||||
@@ -21,8 +21,7 @@
|
||||
},
|
||||
{
|
||||
label: 'Join a vibrant community',
|
||||
description:
|
||||
'Get community support in the Appwrite Discord server.',
|
||||
description: 'Get community support in the Appwrite Discord server.',
|
||||
icon: ChatIcon
|
||||
}
|
||||
];
|
||||
|
||||
@@ -16,8 +16,8 @@
|
||||
</p>
|
||||
|
||||
<p class="font-medium">
|
||||
This credit is available only for users who are verified through the GitHub program
|
||||
as students. The plan is valid until you graduate from GitHub Education.
|
||||
This credit is available only for users who are verified through the GitHub program as
|
||||
students. The plan is valid until you graduate from GitHub Education.
|
||||
</p>
|
||||
</div>
|
||||
<img src={Kickstart} alt="Kickstart" class="mx-auto" />
|
||||
|
||||
@@ -11,7 +11,8 @@
|
||||
import Faq from './(components)/FAQ.svelte';
|
||||
|
||||
const title = 'Education' + TITLE_SUFFIX;
|
||||
const description = "Students, here's your chance to expand your skillset without spending a penny. Sign up for Appwrite Education program to get access to our Pro plan.";
|
||||
const description =
|
||||
"Students, here's your chance to expand your skillset without spending a penny. Sign up for Appwrite Education program to get access to our Pro plan.";
|
||||
const ogImage = DEFAULT_HOST + '/images/open-graph/website.png';
|
||||
</script>
|
||||
|
||||
|
||||
@@ -8,7 +8,8 @@
|
||||
import FloatingHead from '$lib/components/FloatingHead.svelte';
|
||||
|
||||
const title = 'Heroes' + TITLE_SUFFIX;
|
||||
const description = "If you're passionate about helping developers build great products with Appwrite - join our Heroes program and get access to a number of exclusive perks.";
|
||||
const description =
|
||||
"If you're passionate about helping developers build great products with Appwrite - join our Heroes program and get access to a number of exclusive perks.";
|
||||
const ogImage = DEFAULT_HOST + '/images/open-graph/website.png';
|
||||
|
||||
const heroCards: HeroCardProps[] = [
|
||||
|
||||
@@ -18,7 +18,8 @@
|
||||
export let data;
|
||||
|
||||
const title = 'Integrations' + TITLE_SUFFIX;
|
||||
const description = "Connect your favorite apps to Appwrite for one unified tech stack. Explore our catalog of integrations now.";
|
||||
const description =
|
||||
'Connect your favorite apps to Appwrite for one unified tech stack. Explore our catalog of integrations now.';
|
||||
const ogImage = DEFAULT_HOST + '/images/open-graph/website.png';
|
||||
|
||||
// search functionality
|
||||
|
||||
@@ -54,7 +54,8 @@
|
||||
}
|
||||
|
||||
const title = 'Become a Technology Partner' + TITLE_SUFFIX;
|
||||
const description = "Want to integrate your app with Appwrite's API? Apply to our Technology Partners program by filling a short form.";
|
||||
const description =
|
||||
"Want to integrate your app with Appwrite's API? Apply to our Technology Partners program by filling a short form.";
|
||||
const ogImage = DEFAULT_HOST + '/images/open-graph/website.png';
|
||||
</script>
|
||||
|
||||
|
||||
@@ -49,10 +49,10 @@
|
||||
<div class="flex flex-col gap-4">
|
||||
<h1 class="font-aeonik-pro text-title text-primary text-pretty">Partner Tiers</h1>
|
||||
<p class="text-body text-secondary text-pretty font-medium">
|
||||
As you continue to grow, so do your opportunities with Appwrite.
|
||||
Our Partner Program is designed to scale with you as you grow.
|
||||
With flexible tiers tailored to your success. A partnership built to
|
||||
scale together for lasting success in a competitive market.
|
||||
As you continue to grow, so do your opportunities with Appwrite. Our Partner
|
||||
Program is designed to scale with you as you grow. With flexible tiers tailored
|
||||
to your success. A partnership built to scale together for lasting success in a
|
||||
competitive market.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -14,7 +14,8 @@
|
||||
import Features from './(components)/features/Features.svelte';
|
||||
|
||||
const title = 'Auth' + TITLE_SUFFIX;
|
||||
const description = 'Enable secure and reliable user login with Appwrite Auth. We support multiple authentication methods with compliance features out of the box.';
|
||||
const description =
|
||||
'Enable secure and reliable user login with Appwrite Auth. We support multiple authentication methods with compliance features out of the box.';
|
||||
const ogImage = DEFAULT_HOST + '/images/open-graph/website.png';
|
||||
</script>
|
||||
|
||||
|
||||
@@ -18,7 +18,8 @@
|
||||
import { PUBLIC_APPWRITE_DASHBOARD } from '$env/static/public';
|
||||
|
||||
const title = 'Functions' + TITLE_SUFFIX;
|
||||
const description = "Appwrite Functions offer everything you need to deploy and scale serverless functions easily, without any server management overhead.";
|
||||
const description =
|
||||
'Appwrite Functions offer everything you need to deploy and scale serverless functions easily, without any server management overhead.';
|
||||
const ogImage = DEFAULT_HOST + '/images/open-graph/website.png';
|
||||
</script>
|
||||
|
||||
|
||||
@@ -12,7 +12,8 @@
|
||||
import { PUBLIC_APPWRITE_DASHBOARD } from '$env/static/public';
|
||||
|
||||
const title = 'Messaging' + TITLE_SUFFIX;
|
||||
const description = "Appwrite Messaging allows you to communicate with your audience across various mediums. Push notifications, SMS and emails - set up within minutes!";
|
||||
const description =
|
||||
'Appwrite Messaging allows you to communicate with your audience across various mediums. Push notifications, SMS and emails - set up within minutes!';
|
||||
const ogImage = DEFAULT_HOST + '/images/open-graph/website.png';
|
||||
|
||||
const codeTopic = [
|
||||
|
||||
@@ -17,7 +17,8 @@
|
||||
import Optimized from './(components)/Optimized.svelte';
|
||||
|
||||
const title = 'Storage' + TITLE_SUFFIX;
|
||||
const description = "Get to know Appwrite Storage - our robust infrastructure allows you to store, optimize and encrypt all of your project files in one place.";
|
||||
const description =
|
||||
'Get to know Appwrite Storage - our robust infrastructure allows you to store, optimize and encrypt all of your project files in one place.';
|
||||
const ogImage = DEFAULT_HOST + '/images/open-graph/website.png';
|
||||
</script>
|
||||
|
||||
|
||||
@@ -23,7 +23,8 @@
|
||||
import CommunitySupportChat from '$lib/components/CommunitySupportChat.svelte';
|
||||
|
||||
const title = 'Startups' + TITLE_SUFFIX;
|
||||
const description = "Get $20,000 in cloud credits to fulfill all your startup's backend needs. Apply for Appwrite's Startups Program today.";
|
||||
const description =
|
||||
"Get $20,000 in cloud credits to fulfill all your startup's backend needs. Apply for Appwrite's Startups Program today.";
|
||||
const ogImage = DEFAULT_HOST + '/images/open-graph/website.png';
|
||||
|
||||
let personName: string;
|
||||
|
||||
@@ -14,7 +14,8 @@
|
||||
import Input from '$lib/components/ui/Input.svelte';
|
||||
|
||||
const title = 'Threads' + TITLE_SUFFIX;
|
||||
const description = "Appwrite's Threads page showcases our community interactions on Discord. Join the conversation, ask questions, or assist other members with their issues.";
|
||||
const description =
|
||||
"Appwrite's Threads page showcases our community interactions on Discord. Join the conversation, ask questions, or assist other members with their issues.";
|
||||
const ogImage = DEFAULT_HOST + '/images/open-graph/website.png';
|
||||
|
||||
export let data;
|
||||
|
||||
Reference in New Issue
Block a user