Skip to content

Commit

Permalink
docs: add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebastian Sauerer committed Sep 24, 2024
1 parent c14abfd commit e277d15
Show file tree
Hide file tree
Showing 5 changed files with 234 additions and 218 deletions.
99 changes: 0 additions & 99 deletions docs/data-sources/file.md

This file was deleted.

107 changes: 107 additions & 0 deletions docs/data-sources/webhook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "epilot-webhook_webhook Data Source - terraform-provider-epilot-webhook"
subcategory: ""
description: |-
Webhook DataSource
---

# epilot-webhook_webhook (Data Source)

Webhook DataSource

## Example Usage

```terraform
data "epilot-webhook_webhook" "my_webhook" {
}
```

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

### Read-Only

- `auth` (Attributes) (see [below for nested schema](#nestedatt--auth))
- `creation_time` (String) creation timestamp
- `enable_static_ip` (Boolean)
- `enabled` (Boolean)
- `event_name` (String)
- `filter` (Attributes) (see [below for nested schema](#nestedatt--filter))
- `http_method` (String)
- `id` (String) The ID of this resource.
- `name` (String)
- `payload_configuration` (Attributes) Configuration for the webhook payload (see [below for nested schema](#nestedatt--payload_configuration))
- `status` (String)
- `url` (String)

<a id="nestedatt--auth"></a>
### Nested Schema for `auth`

Read-Only:

- `api_key_config` (Attributes) To be sent only if authType is API_KEY (see [below for nested schema](#nestedatt--auth--api_key_config))
- `auth_type` (String)
- `basic_auth_config` (Attributes) To be sent only if authType is BASIC (see [below for nested schema](#nestedatt--auth--basic_auth_config))
- `oauth_config` (Attributes) To be sent only if authType is OAUTH_CLIENT_CREDENTIALS (see [below for nested schema](#nestedatt--auth--oauth_config))

<a id="nestedatt--auth--api_key_config"></a>
### Nested Schema for `auth.api_key_config`

Read-Only:

- `key_name` (String)
- `key_value` (String)


<a id="nestedatt--auth--basic_auth_config"></a>
### Nested Schema for `auth.basic_auth_config`

Read-Only:

- `password` (String)
- `username` (String)


<a id="nestedatt--auth--oauth_config"></a>
### Nested Schema for `auth.oauth_config`

Read-Only:

- `client_id` (String)
- `client_secret` (String)
- `custom_parameter_list` (Attributes List) (see [below for nested schema](#nestedatt--auth--oauth_config--custom_parameter_list))
- `endpoint` (String) Https Endpoint for authentication
- `http_method` (String)

<a id="nestedatt--auth--oauth_config--custom_parameter_list"></a>
### Nested Schema for `auth.oauth_config.custom_parameter_list`

Read-Only:

- `key` (String)
- `type` (String)
- `value` (String)




<a id="nestedatt--filter"></a>
### Nested Schema for `filter`

Read-Only:

- `key_to_filter` (String)
- `supported_values` (List of String)


<a id="nestedatt--payload_configuration"></a>
### Nested Schema for `payload_configuration`

Read-Only:

- `custom_headers` (Map of String) Object representing custom headers as key-value pairs.
- `hydrate_entity` (Boolean)
- `include_activity` (Boolean)
- `include_changed_attributes` (Boolean)
- `include_relations` (Boolean)
9 changes: 4 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "epilot-webhook Provider"
subcategory: ""
description: |-
File API: Upload and manage epilot Files
Webhooks: Service for configuring webhooks on different events
---

# epilot-webhook Provider

File API: Upload and manage epilot Files
Webhooks: Service for configuring webhooks on different events

## Example Usage

Expand All @@ -17,7 +17,7 @@ terraform {
required_providers {
epilot-webhook = {
source = "epilot-dev/epilot-webhook"
version = "0.4.0"
version = "0.5.1"
}
}
}
Expand All @@ -32,6 +32,5 @@ provider "epilot-webhook" {

### Optional

- `cookie_auth` (String, Sensitive)
- `epilot_auth` (String, Sensitive)
- `server_url` (String) Server URL (defaults to https://file.sls.epilot.io)
- `server_url` (String) Server URL (defaults to https://webhooks.sls.epilot.io)
114 changes: 0 additions & 114 deletions docs/resources/file.md

This file was deleted.

Loading

0 comments on commit e277d15

Please sign in to comment.