Skip to content

Commit 349e94c

Browse files
committed
chore: documentation generation
1 parent 6516dc7 commit 349e94c

2 files changed

Lines changed: 12 additions & 42 deletions

File tree

docs/resources/function_deployment.md

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -50,22 +50,22 @@ resource "appwrite_function_deployment" "daily_report" {
5050
### Required
5151

5252
- `function_id` (String) The function ID this deployment belongs to.
53-
- `source_type` (String) The deployment source type. Must be one of `"code"` or `"template"`.
53+
- `source_type` (String) The deployment source type. Must be one of "code" or "template".
5454

5555
### Optional
5656

57-
- `activate` (Boolean) Whether to activate this deployment after creation. Defaults to `false`.
58-
- `code_hash` (String) Hash of the code file for drift detection. Use `filesha256()` to compute.
59-
- `code_path` (String) Local path to the code tar.gz file to upload. Required when `source_type` is `"code"`.
57+
- `activate` (Boolean) Whether to activate this deployment after creation.
58+
- `code_hash` (String) Hash of the code file for drift detection. Use filesha256() to compute.
59+
- `code_path` (String) Local path to the code tar.gz file to upload. Required when source_type is code.
6060
- `commands` (String) Build commands for code deployments.
6161
- `entrypoint` (String) The entrypoint file for code deployments.
6262
- `owner` (String) Repository owner for template deployments.
6363
- `project_id` (String) The Appwrite project ID. Defaults to the provider-level project_id.
6464
- `reference` (String) Reference value for template deployments (e.g. branch name, tag, or commit hash).
6565
- `repository` (String) Repository name for template deployments.
6666
- `root_directory` (String) Root directory in the repository for template deployments.
67-
- `type` (String) Reference type for template deployments (e.g. `"branch"`, `"tag"`, `"commit"`).
68-
- `wait_for_ready` (Boolean) Whether to wait for the deployment to reach ready status before completing. Defaults to `true`.
67+
- `type` (String) Reference type for template deployments (e.g. "branch", "tag", "commit").
68+
- `wait_for_ready` (Boolean) Whether to wait for the deployment to reach ready status before completing. Defaults to true.
6969

7070
### Read-Only
7171

@@ -79,22 +79,7 @@ resource "appwrite_function_deployment" "daily_report" {
7979
- `total_size` (Number) The total size in bytes.
8080
- `updated_at` (String) The deployment last update timestamp in ISO 8601 format.
8181

82-
## Import
8382

84-
Import uses the format `function_id/deployment_id`:
85-
86-
```shell
87-
terraform import appwrite_function_deployment.example 64f2cd7e27bda9f23ab6/69e1ee8d02206401eeec
88-
```
89-
90-
Using an import block (Terraform v1.5.0+):
91-
92-
```hcl
93-
import {
94-
to = appwrite_function_deployment.example
95-
id = "function-id/deployment-id"
96-
}
97-
```
9883

9984
~> **NOTE:** Imported deployments will not have `source_type`, `code_path`, or template attributes in state since these are not returned by the API. The imported resource can be read and deleted but not recreated without specifying these attributes.
10085

docs/resources/site_deployment.md

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -48,23 +48,23 @@ resource "appwrite_site_deployment" "dashboard" {
4848
### Required
4949

5050
- `site_id` (String) The site ID this deployment belongs to.
51-
- `source_type` (String) The deployment source type. Must be one of `"code"` or `"template"`.
51+
- `source_type` (String) The deployment source type. Must be one of "code" or "template".
5252

5353
### Optional
5454

55-
- `activate` (Boolean) Whether to activate this deployment after creation. Defaults to `false`.
55+
- `activate` (Boolean) Whether to activate this deployment after creation.
5656
- `build_command` (String) Custom build command for code deployments.
57-
- `code_hash` (String) Hash of the code file for drift detection. Use `filesha256()` to compute.
58-
- `code_path` (String) Local path to the code file to upload. Required when `source_type` is `"code"`.
57+
- `code_hash` (String) Hash of the code file for drift detection. Use filesha256() to compute.
58+
- `code_path` (String) Local path to the code file to upload. Required when source_type is code.
5959
- `install_command` (String) Custom install command for code deployments.
6060
- `output_directory` (String) Build output directory for code deployments.
6161
- `owner` (String) Repository owner for template deployments.
6262
- `project_id` (String) The Appwrite project ID. Defaults to the provider-level project_id.
6363
- `reference` (String) Reference value for template deployments (e.g. branch name, tag, or commit hash).
6464
- `repository` (String) Repository name for template deployments.
6565
- `root_directory` (String) Root directory in the repository for template deployments.
66-
- `type` (String) Reference type for template deployments (e.g. `"branch"`, `"tag"`, `"commit"`).
67-
- `wait_for_ready` (Boolean) Whether to wait for the deployment to reach ready status before completing. Defaults to `true`.
66+
- `type` (String) Reference type for template deployments (e.g. "branch", "tag", "commit").
67+
- `wait_for_ready` (Boolean) Whether to wait for the deployment to reach ready status before completing. Defaults to true.
6868

6969
### Read-Only
7070

@@ -78,22 +78,7 @@ resource "appwrite_site_deployment" "dashboard" {
7878
- `total_size` (Number) The total size in bytes.
7979
- `updated_at` (String) The deployment last update timestamp in ISO 8601 format.
8080

81-
## Import
8281

83-
Import uses the format `site_id/deployment_id`:
84-
85-
```shell
86-
terraform import appwrite_site_deployment.example 64f2cf04267f49939e93/69e1ee8d1810e6fc3064
87-
```
88-
89-
Using an import block (Terraform v1.5.0+):
90-
91-
```hcl
92-
import {
93-
to = appwrite_site_deployment.example
94-
id = "site-id/deployment-id"
95-
}
96-
```
9782

9883
~> **NOTE:** Imported deployments will not have `source_type`, `code_path`, or template attributes in state since these are not returned by the API. The imported resource can be read and deleted but not recreated without specifying these attributes.
9984

0 commit comments

Comments
 (0)