Skip to content

Commit 9b482f6

Browse files
committed
verbose docs
1 parent 7dce6e8 commit 9b482f6

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

static/api/extensions/v1/api.yaml

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -229,13 +229,22 @@ paths:
229229
post:
230230
tags:
231231
- buckets
232-
summary: Set or replace a custom domain for a bucket
232+
summary: Attach a custom domain to bucket
233233
description: |
234234
Sets a custom domain for a bucket. If the domain is already set, it will be replaced.
235235
236236
:::note
237237
The custom domain must have a CNAME record that points to the bucket URL.
238238
:::
239+
240+
##### Example:
241+
If your bucket is `my-bucket` and you want to use `images.example.com`,
242+
create a CNAME record pointing `images.example.com` to `my-bucket.t3.storage.dev`.
243+
244+
After setting the custom domain, objects will be accessible via:
245+
- `https://images.example.com/object.jpg`
246+
- `https://my-bucket.t3.storage.dev/object.jpg` (original URL still works)
247+
239248
operationId: Tigris_SetCustomDomain
240249
parameters:
241250
- $ref: "#/components/parameters/provider_id"
@@ -263,9 +272,10 @@ paths:
263272
delete:
264273
tags:
265274
- buckets
266-
summary: Remove associated custom domain from a bucket
275+
summary: Remove custom domain from bucket
267276
description: |
268-
Removes the custom domain from a bucket.
277+
Removes the custom domain from a bucket. After removal, the bucket will only be accessible via its default Tigris URL.
278+
The CNAME DNS record can be safely deleted after the custom domain is removed.
269279
operationId: Tigris_DeleteCustomDomain
270280
parameters:
271281
- $ref: "#/components/parameters/provider_id"
@@ -287,9 +297,10 @@ paths:
287297
get:
288298
tags:
289299
- buckets
290-
summary: Get a custom domain for a bucket
300+
summary: Get custom domain settings for a bucket
291301
description: |
292-
Gets a custom domain for a bucket.
302+
Returns the currently configured custom domain for the bucket, or an empty
303+
object if no custom domain is set.
293304
operationId: Tigris_GetCustomDomain
294305
parameters:
295306
- $ref: "#/components/parameters/provider_id"
@@ -674,7 +685,10 @@ components:
674685
properties:
675686
domain_name:
676687
type: string
677-
description: Domain name to be set
688+
example: "images.example.com"
689+
description: |
690+
Custom domain name for the bucket. Must be a valid fully-qualified domain name (FQDN) and
691+
have a CNAME record pointing to the bucket URL.
678692
SetCustomDomainRequest:
679693
type: object
680694
additionalProperties: false

0 commit comments

Comments
 (0)