docs: add examples and generate documentation for all new resources

2026-06-01 11:42:33 -04:00
parent dd77be8ecb
commit f2b245f31a
15 changed files with 336 additions and 1 deletions
@@ -0,0 +1,37 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "immich_person Resource - terraform-provider-immich"
+subcategory: ""
+description: |-
+  Manages an Immich person. Note: Persons are usually created automatically by Immich facial recognition. This resource is used to update their details.
+---
+
+# immich_person (Resource)
+
+Manages an Immich person. Note: Persons are usually created automatically by Immich facial recognition. This resource is used to update their details.
+
+## Example Usage
+
+```terraform
+resource "immich_person" "example" {
+  id         = "your-person-uuid"
+  name       = "John Doe"
+  birth_date = "1990-01-01"
+  is_hidden  = false
+  is_favorite = true
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `id` (String) Unique identifier for the person.
+
+### Optional
+
+- `birth_date` (String) Birth date of the person (ISO 8601).
+- `is_favorite` (Boolean) Whether the person is marked as a favorite.
+- `is_hidden` (Boolean) Whether the person is hidden from the UI.
+- `name` (String) Name of the person.