Skip to content

Commit 065f282

Browse files
committed
improved docs
1 parent 46da3e4 commit 065f282

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

static/api/extensions/v1/api.yaml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -648,25 +648,25 @@ components:
648648
description: |
649649
Configuration for object event notifications via webhook. Receive HTTP callbacks when objects are created, updated, or deleted in your bucket.
650650
651-
**Update behavior (partial updates supported):**
652-
- **Omit field entirely**: Keeps existing settings unchanged
653-
- **Include only `enabled`**: Toggles notifications on/off while preserving all other config
654-
- **Include any field**: Updates specified fields, preserves others (auth not re-required)
655-
- **Remove completely**: Send `{"enabled": false}` with no other fields
651+
**Update behavior:**
652+
- `enabled` is required in all requests
653+
- Other fields (webhook, filter, region, auth) are optional and only update when included
654+
- Omitted optional fields preserve their existing values
655+
- Auth credentials are masked in responses and don't need to be re-sent
656656
657657
**Common operations:**
658658
```json
659-
// Enable notifications (preserves webhook, filter, auth)
660-
{"enabled": true}
659+
// Enable notifications (must provide webhook on first enable)
660+
{"enabled": true, "webhook": "https://webhook.example.com/events"}
661661
662-
// Disable temporarily (keeps all config for later)
663-
{"enabled": false, "webhook": "https://..."}
662+
// Disable temporarily (preserves all config for re-enabling later)
663+
{"enabled": false}
664664
665-
// Update webhook only (preserves auth, filter)
666-
{"webhook": "https://new-endpoint.com"}
665+
// Update webhook while keeping enabled state
666+
{"enabled": true, "webhook": "https://new-endpoint.com"}
667667
668-
// Change auth type (replaces entire auth object)
669-
{"auth": {"token": "new-token"}}
668+
// Change filter only
669+
{"enabled": true, "filter": "size > 1000000"}
670670
671671
// Remove all notifications
672672
{"enabled": false}
@@ -679,7 +679,7 @@ components:
679679
enabled:
680680
type: boolean
681681
description:
682-
Enable or disable notifications (webhook required when true)
682+
Enable or disable notifications. When true, webhook must be provided.
683683
webhook:
684684
type: string
685685
format: uri

0 commit comments

Comments
 (0)