Skip to content

Commit

Permalink
docs: Generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alexluong committed Apr 17, 2024
1 parent d4e53cc commit d66b6aa
Show file tree
Hide file tree
Showing 6 changed files with 93 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/guides/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ Terraform will perform the following actions:
+ "PATCH",
+ "DELETE",
]
+ archived_at = (known after apply)
+ created_at = (known after apply)
+ disabled_at = (known after apply)
+ id = (known after apply)
+ name = "my_source"
+ team_id = (known after apply)
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,5 @@ resource "hookdeck_connection" "connection" {

### Optional

- `api_base` (String) Hookdeck API Base URL. Alternatively, can be configured using the `HOOKDECK_API_BASE` environment variable. (default: https://api.hookdeck.com)
- `api_base` (String) Hookdeck API Base URL. Alternatively, can be configured using the `HOOKDECK_API_BASE` environment variable.
- `api_key` (String, Sensitive) Hookdeck API Key. Alternatively, can be configured using the `HOOKDECK_API_KEY` environment variable.
2 changes: 1 addition & 1 deletion docs/resources/connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,12 @@ resource "hookdeck_connection" "connection_example" {
### Optional

- `description` (String) Description for the connection
- `disabled_at` (String) Date the connection was disabled
- `name` (String) A unique, human-friendly name for the connection
- `rules` (Attributes List) (see [below for nested schema](#nestedatt--rules))

### Read-Only

- `archived_at` (String) Date the connection was archived
- `created_at` (String) Date the connection was created
- `id` (String) ID of the connection
- `paused_at` (String) Date the connection was paused
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/destination.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ resource "hookdeck_destination" "example" {
- `auth_method` (Attributes) Config for the destination's auth method (see [below for nested schema](#nestedatt--auth_method))
- `cli_path` (String) Path for the CLI destination
- `description` (String) Description for the destination
- `disabled_at` (String) Date the destination was disabled
- `http_method` (String) must be one of ["GET", "POST", "PUT", "PATCH", "DELETE"]
HTTP method used on requests sent to the destination, overrides the method used on requests sent to the source.
- `path_forwarding_disabled` (Boolean)
Expand All @@ -51,7 +52,6 @@ HTTP method used on requests sent to the destination, overrides the method used

### Read-Only

- `archived_at` (String) Date the destination was archived
- `created_at` (String) Date the destination was created
- `id` (String) ID of the destination
- `team_id` (String) ID of the workspace
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/source.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ resource "hookdeck_source" "example" {
- `allowed_http_methods` (List of String) List of allowed HTTP methods. Defaults to PUT, POST, PATCH, DELETE.
- `custom_response` (Attributes) Custom response object (see [below for nested schema](#nestedatt--custom_response))
- `description` (String) Description for the source
- `disabled_at` (String) Date the source was disabled

### Read-Only

- `archived_at` (String) Date the source was archived
- `created_at` (String) Date the source was created
- `id` (String) ID of the source
- `team_id` (String) ID of the workspace
Expand Down
88 changes: 88 additions & 0 deletions docs/resources/source_verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,28 +44,37 @@ Optional:
- `cloudsignal` (Attributes) (see [below for nested schema](#nestedatt--verification--cloudsignal))
- `commercelayer` (Attributes) (see [below for nested schema](#nestedatt--verification--commercelayer))
- `courier` (Attributes) (see [below for nested schema](#nestedatt--verification--courier))
- `ebay` (Attributes) (see [below for nested schema](#nestedatt--verification--ebay))
- `enode` (Attributes) (see [below for nested schema](#nestedatt--verification--enode))
- `favro` (Attributes) (see [below for nested schema](#nestedatt--verification--favro))
- `frontapp` (Attributes) (see [below for nested schema](#nestedatt--verification--frontapp))
- `github` (Attributes) (see [below for nested schema](#nestedatt--verification--github))
- `gitlab` (Attributes) (see [below for nested schema](#nestedatt--verification--gitlab))
- `hmac` (Attributes) (see [below for nested schema](#nestedatt--verification--hmac))
- `linear` (Attributes) (see [below for nested schema](#nestedatt--verification--linear))
- `mailgun` (Attributes) (see [below for nested schema](#nestedatt--verification--mailgun))
- `nmi` (Attributes) (see [below for nested schema](#nestedatt--verification--nmi))
- `orb` (Attributes) (see [below for nested schema](#nestedatt--verification--orb))
- `oura` (Attributes) (see [below for nested schema](#nestedatt--verification--oura))
- `persona` (Attributes) (see [below for nested schema](#nestedatt--verification--persona))
- `pipedrive` (Attributes) (see [below for nested schema](#nestedatt--verification--pipedrive))
- `postmark` (Attributes) (see [below for nested schema](#nestedatt--verification--postmark))
- `property_finder` (Attributes) (see [below for nested schema](#nestedatt--verification--property_finder))
- `pylon` (Attributes) (see [below for nested schema](#nestedatt--verification--pylon))
- `recharge` (Attributes) (see [below for nested schema](#nestedatt--verification--recharge))
- `repay` (Attributes) (see [below for nested schema](#nestedatt--verification--repay))
- `sanity` (Attributes) (see [below for nested schema](#nestedatt--verification--sanity))
- `sendgrid` (Attributes) (see [below for nested schema](#nestedatt--verification--sendgrid))
- `shopify` (Attributes) (see [below for nested schema](#nestedatt--verification--shopify))
- `shopline` (Attributes) (see [below for nested schema](#nestedatt--verification--shopline))
- `solidgate` (Attributes) (see [below for nested schema](#nestedatt--verification--solidgate))
- `square` (Attributes) (see [below for nested schema](#nestedatt--verification--square))
- `stripe` (Attributes) (see [below for nested schema](#nestedatt--verification--stripe))
- `svix` (Attributes) (see [below for nested schema](#nestedatt--verification--svix))
- `synctera` (Attributes) (see [below for nested schema](#nestedatt--verification--synctera))
- `telnyx` (Attributes) (see [below for nested schema](#nestedatt--verification--telnyx))
- `threedeye` (Attributes) (see [below for nested schema](#nestedatt--verification--threedeye))
- `tokenio` (Attributes) (see [below for nested schema](#nestedatt--verification--tokenio))
- `trello` (Attributes) (see [below for nested schema](#nestedatt--verification--trello))
- `twitch` (Attributes) (see [below for nested schema](#nestedatt--verification--twitch))
- `twitter` (Attributes) (see [below for nested schema](#nestedatt--verification--twitter))
Expand Down Expand Up @@ -138,6 +147,26 @@ Required:
- `webhook_secret_key` (String, Sensitive)


<a id="nestedatt--verification--ebay"></a>
### Nested Schema for `verification.ebay`

Required:

- `client_id` (String, Sensitive)
- `client_secret` (String, Sensitive)
- `dev_id` (String, Sensitive)
- `environment` (String, Sensitive)
- `verification_token` (String, Sensitive)


<a id="nestedatt--verification--enode"></a>
### Nested Schema for `verification.enode`

Required:

- `webhook_secret_key` (String, Sensitive)


<a id="nestedatt--verification--favro"></a>
### Nested Schema for `verification.favro`

Expand All @@ -146,6 +175,14 @@ Required:
- `webhook_secret_key` (String, Sensitive)


<a id="nestedatt--verification--frontapp"></a>
### Nested Schema for `verification.frontapp`

Required:

- `webhook_secret_key` (String, Sensitive)


<a id="nestedatt--verification--github"></a>
### Nested Schema for `verification.github`

Expand Down Expand Up @@ -173,6 +210,14 @@ Required:
- `webhook_secret_key` (String, Sensitive)


<a id="nestedatt--verification--linear"></a>
### Nested Schema for `verification.linear`

Required:

- `webhook_secret_key` (String, Sensitive)


<a id="nestedatt--verification--mailgun"></a>
### Nested Schema for `verification.mailgun`

Expand All @@ -189,6 +234,14 @@ Required:
- `webhook_secret_key` (String, Sensitive)


<a id="nestedatt--verification--orb"></a>
### Nested Schema for `verification.orb`

Required:

- `webhook_secret_key` (String, Sensitive)


<a id="nestedatt--verification--oura"></a>
### Nested Schema for `verification.oura`

Expand Down Expand Up @@ -230,11 +283,22 @@ Required:
- `webhook_secret_key` (String, Sensitive)


<a id="nestedatt--verification--pylon"></a>
### Nested Schema for `verification.pylon`

Required:

- `webhook_secret_key` (String, Sensitive)


<a id="nestedatt--verification--recharge"></a>
### Nested Schema for `verification.recharge`

Required:

- `algorithm` (String)
- `encoding` (String)
- `header_key` (String)
- `webhook_secret_key` (String, Sensitive)


Expand Down Expand Up @@ -270,6 +334,14 @@ Required:
- `webhook_secret_key` (String, Sensitive)


<a id="nestedatt--verification--shopline"></a>
### Nested Schema for `verification.shopline`

Required:

- `webhook_secret_key` (String, Sensitive)


<a id="nestedatt--verification--solidgate"></a>
### Nested Schema for `verification.solidgate`

Expand Down Expand Up @@ -310,6 +382,14 @@ Required:
- `webhook_secret_key` (String, Sensitive)


<a id="nestedatt--verification--telnyx"></a>
### Nested Schema for `verification.telnyx`

Required:

- `public_key` (String, Sensitive)


<a id="nestedatt--verification--threedeye"></a>
### Nested Schema for `verification.threedeye`

Expand All @@ -318,6 +398,14 @@ Required:
- `webhook_secret_key` (String, Sensitive)


<a id="nestedatt--verification--tokenio"></a>
### Nested Schema for `verification.tokenio`

Required:

- `public_key` (String, Sensitive)


<a id="nestedatt--verification--trello"></a>
### Nested Schema for `verification.trello`

Expand Down

0 comments on commit d66b6aa

Please sign in to comment.