Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
Signed-off-by: KeisukeYamashita <19yamashita15@gmail.com>
  • Loading branch information
KeisukeYamashita committed Nov 3, 2021
1 parent eeec3f3 commit 7d92b72
Show file tree
Hide file tree
Showing 5 changed files with 81 additions and 7 deletions.
34 changes: 34 additions & 0 deletions docs/data-sources/document.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "typesense_document Data Source - terraform-provider-typesense"
subcategory: ""
description: |-
Item in a collection
---

# typesense_document (Data Source)

Item in a collection

## Example Usage

```terraform
data "typesense_document" "my_doc" {
name = "my-doc"
collection_name = "my-collection"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **collection_name** (String) Name of the collection
- **id** (String) ID of the document

### Read-Only

- **document** (Map of String) Document's body


2 changes: 1 addition & 1 deletion docs/resources/collection_alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,5 @@ resource "typesense_collection_alias" "my_alias" {
Import is supported using the following syntax:

```shell
terraform import typesense_collection_alias.my_alias my-alias
terraform import typesense_collection_alias.my_alias my_collection.my-alias
```
2 changes: 1 addition & 1 deletion docs/resources/curation.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,5 +83,5 @@ Required:
Import is supported using the following syntax:

```shell
terraform import typesense_curation.my_curation my-curation
terraform import typesense_curation.my_curation my_collection.my-curation
```
43 changes: 43 additions & 0 deletions docs/resources/document.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "typesense_document Resource - terraform-provider-typesense"
subcategory: ""
description: |-
Item in a collection
---

# typesense_document (Resource)

Item in a collection

## Example Usage

```terraform
resource "typesense_document" "doc" {
id = "doc"
collection_name = typesense_collection.my_collection.name
document = {
"company_name" = "Stark Industries"
"num_employees" = 5215
"country" = "USA"
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **collection_name** (String) Name of the collection
- **document** (Map of String) Document's body
- **id** (String) ID of the document

## Import

Import is supported using the following syntax:

```shell
terraform import typesense_document.my_doc my_collection.my-doc
```
7 changes: 2 additions & 5 deletions docs/resources/synonyms.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,17 @@ resource "typesense_synonyms" "my_synonyms" {

- **collection_name** (String) Name of the collection
- **name** (String) Name of the synonyms
- **synonyms** (Block List, Min: 1) (see [below for nested schema](#nestedblock--synonyms))
- **synonyms** (List of String)

### Optional

- **id** (String) The ID of this resource.
- **root** (String) Root for one-way synonym

<a id="nestedblock--synonyms"></a>
### Nested Schema for `synonyms`

## Import

Import is supported using the following syntax:

```shell
terraform import typesense_synonyms.my_synonyms my_synonyms
terraform import typesense_synonyms.my_synonyms my_collection.my_synonyms
```

0 comments on commit 7d92b72

Please sign in to comment.