Skip to content

Commit 763bfb7

Browse files
committed
docs(cli): use 'hookdeck gateway connection' in connection command examples
Update Example strings in connection create, delete, get, list, and upsert so help text shows the preferred gateway-scoped form instead of the deprecated root-level 'hookdeck connection'. Made-with: Cursor
1 parent 26bcf0a commit 763bfb7

5 files changed

Lines changed: 17 additions & 17 deletions

File tree

pkg/cmd/connection_create.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,19 +112,19 @@ func newConnectionCreateCmd() *connectionCreateCmd {
112112
113113
Examples:
114114
# Create with inline source and destination
115-
hookdeck connection create \
115+
hookdeck gateway connection create \
116116
--name "test-webhooks-to-local" \
117117
--source-type WEBHOOK --source-name "test-webhooks" \
118118
--destination-type CLI --destination-name "local-dev"
119119
120120
# Create with existing resources
121-
hookdeck connection create \
121+
hookdeck gateway connection create \
122122
--name "github-to-api" \
123123
--source-id src_abc123 \
124124
--destination-id dst_def456
125125
126126
# Create with source configuration options
127-
hookdeck connection create \
127+
hookdeck gateway connection create \
128128
--name "api-webhooks" \
129129
--source-type WEBHOOK --source-name "api-source" \
130130
--source-allowed-http-methods "POST,PUT,PATCH" \

pkg/cmd/connection_delete.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ func newConnectionDeleteCmd() *connectionDeleteCmd {
2626
2727
Examples:
2828
# Delete a connection (with confirmation)
29-
hookdeck connection delete conn_abc123
29+
hookdeck gateway connection delete conn_abc123
3030
3131
# Force delete without confirmation
32-
hookdeck connection delete conn_abc123 --force`,
32+
hookdeck gateway connection delete conn_abc123 --force`,
3333
PreRunE: cc.validateFlags,
3434
RunE: cc.runConnectionDeleteCmd,
3535
}

pkg/cmd/connection_get.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ func newConnectionGetCmd() *connectionGetCmd {
3333
3434
Examples:
3535
# Get connection by ID
36-
hookdeck connection get conn_abc123
36+
hookdeck gateway connection get conn_abc123
3737
3838
# Get connection by name
39-
hookdeck connection get my-connection`,
39+
hookdeck gateway connection get my-connection`,
4040
RunE: cc.runConnectionGetCmd,
4141
}
4242
cc.cmd.Annotations = map[string]string{

pkg/cmd/connection_list.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,22 +34,22 @@ func newConnectionListCmd() *connectionListCmd {
3434
3535
Examples:
3636
# List all connections
37-
hookdeck connection list
37+
hookdeck gateway connection list
3838
3939
# Filter by connection name
40-
hookdeck connection list --name my-connection
40+
hookdeck gateway connection list --name my-connection
4141
4242
# Filter by source ID
43-
hookdeck connection list --source-id src_abc123
43+
hookdeck gateway connection list --source-id src_abc123
4444
4545
# Filter by destination ID
46-
hookdeck connection list --destination-id dst_def456
46+
hookdeck gateway connection list --destination-id dst_def456
4747
4848
# Include disabled connections
49-
hookdeck connection list --disabled
49+
hookdeck gateway connection list --disabled
5050
5151
# Limit results
52-
hookdeck connection list --limit 10`,
52+
hookdeck gateway connection list --limit 10`,
5353
RunE: cc.runConnectionListCmd,
5454
}
5555

pkg/cmd/connection_upsert.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,22 +42,22 @@ func newConnectionUpsertCmd() *connectionUpsertCmd {
4242
4343
Examples:
4444
# Create or update a connection with inline source and destination
45-
hookdeck connection upsert "my-connection" \
45+
hookdeck gateway connection upsert "my-connection" \
4646
--source-name "stripe-prod" --source-type STRIPE \
4747
--destination-name "my-api" --destination-type HTTP --destination-url https://api.example.com
4848
4949
# Update just the rate limit on an existing connection
50-
hookdeck connection upsert my-connection \
50+
hookdeck gateway connection upsert my-connection \
5151
--destination-rate-limit 100 --destination-rate-limit-period minute
5252
5353
# Update source configuration options
54-
hookdeck connection upsert my-connection \
54+
hookdeck gateway connection upsert my-connection \
5555
--source-allowed-http-methods "POST,PUT,DELETE" \
5656
--source-custom-response-content-type "json" \
5757
--source-custom-response-body '{"status":"received"}'
5858
5959
# Preview changes without applying them
60-
hookdeck connection upsert my-connection \
60+
hookdeck gateway connection upsert my-connection \
6161
--destination-rate-limit 200 --destination-rate-limit-period hour \
6262
--dry-run`,
6363
PreRunE: cu.validateUpsertFlags,

0 commit comments

Comments
 (0)