Skip to content

Commit 46da3e4

Browse files
committed
lint
1 parent 88bf666 commit 46da3e4

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

static/api/extensions/v1/api.yaml

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -647,50 +647,54 @@ components:
647647
type: object
648648
description: |
649649
Configuration for object event notifications via webhook. Receive HTTP callbacks when objects are created, updated, or deleted in your bucket.
650-
650+
651651
**Update behavior (partial updates supported):**
652652
- **Omit field entirely**: Keeps existing settings unchanged
653653
- **Include only `enabled`**: Toggles notifications on/off while preserving all other config
654654
- **Include any field**: Updates specified fields, preserves others (auth not re-required)
655655
- **Remove completely**: Send `{"enabled": false}` with no other fields
656-
656+
657657
**Common operations:**
658658
```json
659659
// Enable notifications (preserves webhook, filter, auth)
660660
{"enabled": true}
661-
661+
662662
// Disable temporarily (keeps all config for later)
663663
{"enabled": false, "webhook": "https://..."}
664-
664+
665665
// Update webhook only (preserves auth, filter)
666666
{"webhook": "https://new-endpoint.com"}
667-
667+
668668
// Change auth type (replaces entire auth object)
669669
{"auth": {"token": "new-token"}}
670-
670+
671671
// Remove all notifications
672672
{"enabled": false}
673673
```
674-
674+
675675
**Note:** Auth credentials are masked in responses. You don't need to re-send them when updating other fields.
676676
required:
677677
- enabled
678678
properties:
679679
enabled:
680680
type: boolean
681-
description: Enable or disable notifications (webhook required when true)
681+
description:
682+
Enable or disable notifications (webhook required when true)
682683
webhook:
683684
type: string
684685
format: uri
685686
description: HTTPS endpoint to receive notification events
686687
example: "https://webhook.example.com/tigris-events"
687688
filter:
688689
type: string
689-
description: SQL WHERE clause to filter which objects trigger notifications (e.g., size comparisons)
690+
description:
691+
SQL WHERE clause to filter which objects trigger notifications
692+
(e.g., size comparisons)
690693
example: "size > 1000000"
691694
region:
692695
type: string
693-
description: Region to process notifications from (defaults to server region)
696+
description:
697+
Region to process notifications from (defaults to server region)
694698
example: "iad"
695699
auth:
696700
$ref: "#/components/schemas/ObjectNotificationAuth"

0 commit comments

Comments
 (0)