Skip to content

Commit 5162765

Browse files
committed
prettier
1 parent 2aff17c commit 5162765

File tree

1 file changed

+23
-13
lines changed

1 file changed

+23
-13
lines changed

static/api/extensions/v1/api.yaml

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -637,7 +637,9 @@ components:
637637
limit_bytes:
638638
type: integer
639639
format: int64
640-
description: The number of bytes that the organization is allowed to store across all of its buckets. Zero means no limit.
640+
description:
641+
The number of bytes that the organization is allowed to store across
642+
all of its buckets. Zero means no limit.
641643
BucketOptions:
642644
type: object
643645
properties:
@@ -660,50 +662,54 @@ components:
660662
type: object
661663
description: |
662664
Configuration for object event notifications via webhook. Receive HTTP callbacks when objects are created, updated, or deleted in your bucket.
663-
665+
664666
**Update behavior (partial updates supported):**
665667
- **Omit field entirely**: Keeps existing settings unchanged
666668
- **Include only `enabled`**: Toggles notifications on/off while preserving all other config
667669
- **Include any field**: Updates specified fields, preserves others (auth not re-required)
668670
- **Remove completely**: Send `{"enabled": false}` with no other fields
669-
671+
670672
**Common operations:**
671673
```json
672674
// Enable notifications (preserves webhook, filter, auth)
673675
{"enabled": true}
674-
676+
675677
// Disable temporarily (keeps all config for later)
676678
{"enabled": false, "webhook": "https://..."}
677-
679+
678680
// Update webhook only (preserves auth, filter)
679681
{"webhook": "https://new-endpoint.com"}
680-
682+
681683
// Change auth type (replaces entire auth object)
682684
{"auth": {"token": "new-token"}}
683-
685+
684686
// Remove all notifications
685687
{"enabled": false}
686688
```
687-
689+
688690
**Note:** Auth credentials are masked in responses. You don't need to re-send them when updating other fields.
689691
required:
690692
- enabled
691693
properties:
692694
enabled:
693695
type: boolean
694-
description: Enable or disable notifications (webhook required when true)
696+
description:
697+
Enable or disable notifications (webhook required when true)
695698
webhook:
696699
type: string
697700
format: uri
698701
description: HTTPS endpoint to receive notification events
699702
example: "https://webhook.example.com/tigris-events"
700703
filter:
701704
type: string
702-
description: SQL WHERE clause to filter which objects trigger notifications (e.g., size comparisons)
705+
description:
706+
SQL WHERE clause to filter which objects trigger notifications
707+
(e.g., size comparisons)
703708
example: "size > 1000000"
704709
region:
705710
type: string
706-
description: Region to process notifications from (defaults to server region)
711+
description:
712+
Region to process notifications from (defaults to server region)
707713
example: "iad"
708714
auth:
709715
$ref: "#/components/schemas/ObjectNotificationAuth"
@@ -1223,7 +1229,11 @@ components:
12231229
enum: [STANDARD, STANDARD_IA, GLACIER, GLACIER_IR]
12241230
Regions:
12251231
type: string
1226-
description: Restricts the regions where bucket data is stored. Default is empty, which means no restrictions. See https://www.tigrisdata.com/docs/objects/object_regions/ for more details.
1232+
description:
1233+
Restricts the regions where bucket data is stored. Default is empty,
1234+
which means no restrictions. See
1235+
https://www.tigrisdata.com/docs/objects/object_regions/ for more
1236+
details.
12271237
GenericError:
12281238
type: object
12291239
properties:
@@ -1256,7 +1266,7 @@ components:
12561266
type: apiKey
12571267
in: header
12581268
name: X-Tigris-Nonce
1259-
description: |
1269+
description: |
12601270
Random unique string to identify the request and prevent replay attacks. Example: "f8d133cb-5a42-47b1-9ef2-874bb55bab72"
12611271
Timestamp:
12621272
type: apiKey

0 commit comments

Comments
 (0)