Skip to content

Commit 5a928cd

Browse files
committed
Add notes about create|read|update|destroy_path
1 parent 6a148fd commit 5a928cd

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ Have a look at the [examples directory](examples) for some use cases
3434

3535
## `restapi` resource configuration
3636
- `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.
37+
- `create_path` (string, optional): Defaults to `path`. The API path on top of the base URL set in the provider that represents where to WRITE (POST) objects of this type on the API server.
38+
- `read_path` (string, optional): Defaults to `path`. The API path on top of the base URL set in the provider that represents where to READ (GET) objects of this type on the API server.
39+
- `update_path` (string, optional): Defaults to `path`. The API path on top of the base URL set in the provider that represents where to MODIFY (PUT) objects of this type on the API server.
40+
- `destroy_path` (string, optional): Defaults to `path`. The API path on top of the base URL set in the provider that represents where to DESTROY (DELETE) objects of this type on the API server.
3741
- `data` (string, required): Valid JSON data that this provider will manage with the API server. This should represent the whole API object that you want to create. The provider's information.
3842
- `debug` (boolean, optional): Whether to emit verbose debug output while working with the API object on the server. This can be gathered by setting `TF_LOG=1` environment variable.
3943

0 commit comments

Comments
 (0)