Custom domain integration for partner integration APIs

Author: adilansari

static/api/extensions/v1/api.yaml

@@ -43,11 +43,11 @@ info:
 
     For example, for a `POST` request to `/provider/laravel/orgs/my-org/provision`, the `CanonicalURI` would be:
     ```
-    https://mgmt.storage.dev/provider/your-provider-id/orgs/user-org-id/provision
+    https://fly.mgnt.storage.tigris.dev/provider/your-provider-id/orgs/user-org-id/provision
     ```
     And for a `GET` request with query parameters:
     ```
-    https://mgmt.storage.dev/provider/your-provider-id/orgs/?include_inactive=true
+    https://fly.mgnt.storage.tigris.dev/provider/your-provider-id/orgs/?include_inactive=true
     ```
     :::
 
@@ -66,7 +66,7 @@ info:
     ```
   version: 0.0.1
 servers:
-  - url: https://mgmt.storage.dev
+  - url: https://fly.mgnt.storage.tigris.dev
     description: Tigris production server
 tags:
   - name: buckets
@@ -225,6 +225,89 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/GenericError"
+  /v1/providers/{provider_id}/orgs/{org_id}/buckets/{bucket_name}/domain:
+    post:
+      tags:
+        - buckets
+      summary: Set or replace a custom domain for a bucket
+      description: |
+        Sets a custom domain for a bucket. If the domain is already set, it will be replaced.
+        
+        :::note
+        The custom domain must have a CNAME record that points to the bucket URL.
+        :::
+      operationId: Tigris_SetCustomDomain
+      parameters:
+        - $ref: "#/components/parameters/provider_id"
+        - $ref: "#/components/parameters/org_id"
+        - $ref: "#/components/parameters/bucket_name"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SetCustomDomainRequest"
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SetCustomDomainResponse"
+        default:
+          description: Unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GenericError"
+    delete:
+      tags:
+        - buckets
+      summary: Remove associated custom domain from a bucket
+      description: |
+         Removes the custom domain from a bucket.
+      operationId: Tigris_DeleteCustomDomain
+      parameters:
+        - $ref: "#/components/parameters/provider_id"
+        - $ref: "#/components/parameters/org_id"
+        - $ref: "#/components/parameters/bucket_name"
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/DeleteCustomDomainResponse"
+        default:
+          description: Unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GenericError"
+    get:
+      tags:
+        - buckets
+      summary: Get a custom domain for a bucket
+      description: |
+        Gets a custom domain for a bucket.
+      operationId: Tigris_GetCustomDomain
+      parameters:
+        - $ref: "#/components/parameters/provider_id"
+        - $ref: "#/components/parameters/org_id"
+        - $ref: "#/components/parameters/bucket_name"
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetCustomDomainResponse"
+        default:
+          description: Unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GenericError"
 
   /v1/providers/{provider_id}/orgs/{org_id}/key/rotate:
     post:
@@ -585,6 +668,33 @@ components:
       properties:
         data:
           $ref: "#/components/schemas/Invoice"
+    BucketWebsiteSettings:
+      type: object
+      additionalProperties: false
+      properties:
+        domain_name:
+          type: string
+          description: Domain name to be set
+    SetCustomDomainRequest:
+      type: object
+      additionalProperties: false
+      required:
+        - website
+      properties:
+        website:
+          $ref: "#/components/schemas/BucketWebsiteSettings"
+    SetCustomDomainResponse:
+      type: object
+    DeleteCustomDomainResponse:
+      type: object
+    GetCustomDomainResponse:
+      type: object
+      additionalProperties: false
+      required:
+        - website
+      properties:
+        website:
+          $ref: "#/components/schemas/BucketWebsiteSettings"
     Invoice:
       type: object
       properties:
@@ -740,6 +850,8 @@ components:
         object_acl_enabled:
           type: boolean
           description: If set to true, per object ACL is enabled
+        website:
+          $ref: "#/components/schemas/BucketWebsiteSettings"
     GetUsageResponse:
       type: object
       properties: