You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/resources/object.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,16 +15,16 @@ description: |-
15
15
16
16
### Required
17
17
18
-
-**data** (String, Required) Valid JSON data that this provider will manage with the API server.
18
+
-**data** (String, Required) Valid JSON object that this provider will manage with the API server.
19
19
-**path** (String, Required) The API path on top of the base URL set in the provider that represents objects of this type on the API server.
20
20
21
21
### Optional
22
22
23
23
-**create_method** (String, Optional) Defaults to `create_method` set on the provider. Allows per-resource override of `create_method` (see `create_method` provider config documentation)
24
24
-**create_path** (String, Optional) Defaults to `path`. The API path that represents where to CREATE (POST) objects of this type on the API server. The string `{id}` will be replaced with the terraform ID of the object if the data contains the `id_attribute`.
25
25
-**debug** (Boolean, Optional) Whether to emit verbose debug output while working with the API object on the server.
26
+
-**destroy_data** (String, Optional) Valid JSON object to pass during to destroy requests.
26
27
-**destroy_method** (String, Optional) Defaults to `destroy_method` set on the provider. Allows per-resource override of `destroy_method` (see `destroy_method` provider config documentation)
27
-
-**destroy_data** (String, Optional) Valid JSON data that this provider will send to the API server on DESTROY (DELETE) operations. If not set, defaults to the value of `data`.
28
28
-**destroy_path** (String, Optional) Defaults to `path/{id}`. The API path that represents where to DESTROY (DELETE) objects of this type on the API server. The string `{id}` will be replaced with the terraform ID of the object.
29
29
-**force_new** (List of String, Optional) Any changes to these values will result in recreating the resource instead of updating.
30
30
-**id** (String, Optional) The ID of this resource.
@@ -34,8 +34,8 @@ description: |-
34
34
-**read_method** (String, Optional) Defaults to `read_method` set on the provider. Allows per-resource override of `read_method` (see `read_method` provider config documentation)
35
35
-**read_path** (String, Optional) Defaults to `path/{id}`. The API path that represents where to READ (GET) objects of this type on the API server. The string `{id}` will be replaced with the terraform ID of the object.
36
36
-**read_search** (Map of String, Optional) Custom search for `read_path`. This map will take `search_key`, `search_value`, `results_key` and `query_string` (see datasource config documentation)
37
+
-**update_data** (String, Optional) Valid JSON object to pass during to update requests.
37
38
-**update_method** (String, Optional) Defaults to `update_method` set on the provider. Allows per-resource override of `update_method` (see `update_method` provider config documentation)
38
-
-**update_data** (String, Optional) Valid JSON data that this provider will send to the API server on UPDATE (PUT) operations. If not set, defaults to the value of `data`.
39
39
-**update_path** (String, Optional) Defaults to `path/{id}`. The API path that represents where to UPDATE (PUT) objects of this type on the API server. The string `{id}` will be replaced with the terraform ID of the object.
0 commit comments