@opusdns/api 0.86.0 → 0.88.0

package/src/openapi.yaml

@@ -1531,6 +1531,53 @@ components:
       - algorithm
       title: DomainDnssecDataResponse
       type: object
+    DomainForward:
+      properties:
+        created_on:
+          format: date-time
+          title: Created On
+          type: string
+        redirects:
+          items:
+            $ref: '#/components/schemas/HttpRedirect'
+          title: Redirects
+          type: array
+        request_protocol:
+          $ref: '#/components/schemas/HttpProtocol'
+        updated_on:
+          format: date-time
+          title: Updated On
+          type: string
+        wildcard:
+          title: Wildcard
+          type: boolean
+        zone_name:
+          title: Zone Name
+          type: string
+      required:
+      - wildcard
+      - redirects
+      - zone_name
+      - request_protocol
+      - updated_on
+      - created_on
+      title: DomainForward
+      type: object
+    DomainForwardRequest:
+      properties:
+        redirects:
+          items:
+            $ref: '#/components/schemas/HttpRedirect'
+          title: Redirects
+          type: array
+        wildcard:
+          title: Wildcard
+          type: boolean
+      required:
+      - wildcard
+      - redirects
+      title: DomainForwardRequest
+      type: object
     DomainLifecycleBase:
       properties:
         add_grace_period:
@@ -2459,6 +2506,45 @@ components:
       - status
       title: RequestValidationError
       type: object
+    HttpProtocol:
+      enum:
+      - http
+      - https
+      title: HttpProtocol
+      type: string
+    HttpRedirect:
+      properties:
+        redirect_code:
+          $ref: '#/components/schemas/RedirectCode'
+        request_path:
+          title: Request Path
+          type: string
+        request_subdomain:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Request Subdomain
+        target_domain:
+          title: Target Domain
+          type: string
+        target_path:
+          title: Target Path
+          type: string
+        target_protocol:
+          $ref: '#/components/schemas/HttpProtocol'
+        target_subdomain:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Target Subdomain
+      required:
+      - request_path
+      - target_protocol
+      - target_domain
+      - target_path
+      - redirect_code
+      title: HttpRedirect
+      type: object
     IdnBase:
       properties:
         idn_capable:
@@ -3504,20 +3590,6 @@ components:
       - pagination
       title: Pagination[Organization]
       type: object
-    Pagination_Redirect_:
-      properties:
-        pagination:
-          $ref: '#/components/schemas/PaginationMetadata'
-        results:
-          items:
-            $ref: '#/components/schemas/Redirect'
-          title: Results
-          type: array
-      required:
-      - results
-      - pagination
-      title: Pagination[Redirect]
-      type: object
     Pagination_User_:
       properties:
         pagination:
@@ -3781,141 +3853,14 @@ components:
           title: Rdap Server
       title: RdapBase
       type: object
-    Redirect:
-      properties:
-        redirect_code:
-          title: Redirect Code
-          type: integer
-        request_domain:
-          title: Request Domain
-          type: string
-        request_path:
-          title: Request Path
-          type: string
-        request_protocol:
-          title: Request Protocol
-          type: string
-        request_subdomain:
-          title: Request Subdomain
-          type: string
-        target_domain:
-          title: Target Domain
-          type: string
-        target_path:
-          title: Target Path
-          type: string
-        target_protocol:
-          title: Target Protocol
-          type: string
-        target_subdomain:
-          title: Target Subdomain
-          type: string
-      required:
-      - request_protocol
-      - request_subdomain
-      - request_path
-      - target_protocol
-      - target_subdomain
-      - target_domain
-      - target_path
-      - redirect_code
-      - request_domain
-      title: Redirect
-      type: object
-    RedirectPatchOp:
-      properties:
-        op:
-          $ref: '#/components/schemas/PatchOp'
-        redirect:
-          anyOf:
-          - $ref: '#/components/schemas/Redirect'
-          - $ref: '#/components/schemas/RedirectRemove'
-          title: Redirect
-      required:
-      - op
-      - redirect
-      title: RedirectPatchOp
-      type: object
-    RedirectPatchOps:
-      properties:
-        ops:
-          items:
-            $ref: '#/components/schemas/RedirectPatchOp'
-          title: Ops
-          type: array
-      required:
-      - ops
-      title: RedirectPatchOps
-      type: object
-    RedirectRemove:
-      properties:
-        request_domain:
-          title: Request Domain
-          type: string
-        request_path:
-          title: Request Path
-          type: string
-        request_protocol:
-          title: Request Protocol
-          type: string
-        request_subdomain:
-          title: Request Subdomain
-          type: string
-      required:
-      - request_protocol
-      - request_subdomain
-      - request_path
-      - request_domain
-      title: RedirectRemove
-      type: object
-    RedirectSet:
-      properties:
-        redirects:
-          items:
-            $ref: '#/components/schemas/RedirectUpdate'
-          title: Redirects
-          type: array
-      required:
-      - redirects
-      title: RedirectSet
-      type: object
-    RedirectUpdate:
-      properties:
-        redirect_code:
-          title: Redirect Code
-          type: integer
-        request_path:
-          title: Request Path
-          type: string
-        request_protocol:
-          title: Request Protocol
-          type: string
-        request_subdomain:
-          title: Request Subdomain
-          type: string
-        target_domain:
-          title: Target Domain
-          type: string
-        target_path:
-          title: Target Path
-          type: string
-        target_protocol:
-          title: Target Protocol
-          type: string
-        target_subdomain:
-          title: Target Subdomain
-          type: string
-      required:
-      - request_protocol
-      - request_subdomain
-      - request_path
-      - target_protocol
-      - target_subdomain
-      - target_domain
-      - target_path
-      - redirect_code
-      title: RedirectUpdate
-      type: object
+    RedirectCode:
+      enum:
+      - 301
+      - 302
+      - 307
+      - 308
+      title: RedirectCode
+      type: integer
     RegistrantChangeType:
       enum:
       - update
@@ -4952,7 +4897,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-10-27-080440
+  version: 2025-10-28-153856
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -6430,15 +6375,18 @@ paths:
       summary: Update Zone Rrsets
       tags:
       - dns
-  /v1/domain-forwards:
+  /v1/domain-forwards/{zone_name}/disable:
     patch:
-      operationId: patch_redirects_v1_domain_forwards_patch
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/RedirectPatchOps'
+      operationId: disable_domain_forward_v1_domain_forwards__zone_name__disable_patch
+      parameters:
+      - description: DNS zone name (trailing dot optional)
+        in: path
+        name: zone_name
         required: true
+        schema:
+          description: DNS zone name (trailing dot optional)
+          title: Zone Name
+          type: string
       responses:
         '204':
           description: Successful Response
@@ -6450,12 +6398,12 @@ paths:
           description: Validation Error
       security:
       - OAuth2PasswordBearer: []
-      summary: Patch Redirects
+      summary: Disable Domain Forward
       tags:
       - domain_forward
-  /v1/domain-forwards/{zone_name}:
-    delete:
-      operationId: delete_redirects_v1_domain_forwards__zone_name__delete
+  /v1/domain-forwards/{zone_name}/enable:
+    patch:
+      operationId: enable_domain_forward_v1_domain_forwards__zone_name__enable_patch
       parameters:
       - description: DNS zone name (trailing dot optional)
         in: path
@@ -6465,6 +6413,13 @@ paths:
           description: DNS zone name (trailing dot optional)
           title: Zone Name
           type: string
+      - in: query
+        name: auto_create_zone
+        required: false
+        schema:
+          default: false
+          title: Auto Create Zone
+          type: boolean
       responses:
         '204':
           description: Successful Response
@@ -6476,12 +6431,18 @@ paths:
           description: Validation Error
       security:
       - OAuth2PasswordBearer: []
-      summary: Delete Redirects
+      summary: Enable Domain Forward
       tags:
       - domain_forward
-    get:
-      operationId: get_redirects_v1_domain_forwards__zone_name__get
+  /v1/domain-forwards/{zone_name}/{request_protocol}:
+    delete:
+      operationId: delete_domain_forward_v1_domain_forwards__zone_name___request_protocol__delete
       parameters:
+      - in: path
+        name: request_protocol
+        required: true
+        schema:
+          $ref: '#/components/schemas/HttpProtocol'
       - description: DNS zone name (trailing dot optional)
         in: path
         name: zone_name
@@ -6490,29 +6451,42 @@ paths:
           description: DNS zone name (trailing dot optional)
           title: Zone Name
           type: string
-      - in: query
-        name: page
-        required: false
+      responses:
+        '204':
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Delete Domain Forward
+      tags:
+      - domain_forward
+    get:
+      operationId: get_domain_forward_v1_domain_forwards__zone_name___request_protocol__get
+      parameters:
+      - in: path
+        name: request_protocol
+        required: true
         schema:
-          default: 1
-          minimum: 1
-          title: Page
-          type: integer
-      - in: query
-        name: page_size
-        required: false
+          $ref: '#/components/schemas/HttpProtocol'
+      - description: DNS zone name (trailing dot optional)
+        in: path
+        name: zone_name
+        required: true
         schema:
-          default: 10
-          maximum: 100
-          minimum: 1
-          title: Page Size
-          type: integer
+          description: DNS zone name (trailing dot optional)
+          title: Zone Name
+          type: string
       responses:
         '200':
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Pagination_Redirect_'
+                $ref: '#/components/schemas/DomainForward'
           description: Successful Response
         '422':
           content:
@@ -6522,12 +6496,17 @@ paths:
           description: Validation Error
       security:
       - OAuth2PasswordBearer: []
-      summary: Get Redirects
+      summary: Get Domain Forward
       tags:
       - domain_forward
     post:
-      operationId: create_redirects_v1_domain_forwards__zone_name__post
+      operationId: create_domain_forward_v1_domain_forwards__zone_name___request_protocol__post
       parameters:
+      - in: path
+        name: request_protocol
+        required: true
+        schema:
+          $ref: '#/components/schemas/HttpProtocol'
       - description: DNS zone name (trailing dot optional)
         in: path
         name: zone_name
@@ -6540,10 +6519,14 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/RedirectSet'
+              $ref: '#/components/schemas/DomainForwardRequest'
         required: true
       responses:
         '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DomainForward'
           description: Successful Response
         '409':
           content:
@@ -6566,12 +6549,17 @@ paths:
           description: Validation Error
       security:
       - OAuth2PasswordBearer: []
-      summary: Create Redirects
+      summary: Create Domain Forward
       tags:
       - domain_forward
     put:
-      operationId: update_redirects_v1_domain_forwards__zone_name__put
+      operationId: update_domain_forward_v1_domain_forwards__zone_name___request_protocol__put
       parameters:
+      - in: path
+        name: request_protocol
+        required: true
+        schema:
+          $ref: '#/components/schemas/HttpProtocol'
       - description: DNS zone name (trailing dot optional)
         in: path
         name: zone_name
@@ -6584,10 +6572,14 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/RedirectSet'
+              $ref: '#/components/schemas/DomainForwardRequest'
         required: true
       responses:
-        '204':
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DomainForward'
           description: Successful Response
         '409':
           content:
@@ -6610,66 +6602,7 @@ paths:
           description: Validation Error
       security:
       - OAuth2PasswordBearer: []
-      summary: Update Redirects
-      tags:
-      - domain_forward
-  /v1/domain-forwards/{zone_name}/disable:
-    patch:
-      operationId: disable_domain_forward_v1_domain_forwards__zone_name__disable_patch
-      parameters:
-      - description: DNS zone name (trailing dot optional)
-        in: path
-        name: zone_name
-        required: true
-        schema:
-          description: DNS zone name (trailing dot optional)
-          title: Zone Name
-          type: string
-      responses:
-        '204':
-          description: Successful Response
-        '422':
-          content:
-            application/problem+json:
-              schema:
-                $ref: '#/components/schemas/HTTPValidationError'
-          description: Validation Error
-      security:
-      - OAuth2PasswordBearer: []
-      summary: Disable Domain Forward
-      tags:
-      - domain_forward
-  /v1/domain-forwards/{zone_name}/enable:
-    patch:
-      operationId: enable_domain_forward_v1_domain_forwards__zone_name__enable_patch
-      parameters:
-      - description: DNS zone name (trailing dot optional)
-        in: path
-        name: zone_name
-        required: true
-        schema:
-          description: DNS zone name (trailing dot optional)
-          title: Zone Name
-          type: string
-      - in: query
-        name: auto_create_zone
-        required: false
-        schema:
-          default: false
-          title: Auto Create Zone
-          type: boolean
-      responses:
-        '204':
-          description: Successful Response
-        '422':
-          content:
-            application/problem+json:
-              schema:
-                $ref: '#/components/schemas/HTTPValidationError'
-          description: Validation Error
-      security:
-      - OAuth2PasswordBearer: []
-      summary: Enable Domain Forward
+      summary: Update Domain Forward
       tags:
       - domain_forward
   /v1/domain-search/suggest:
@@ -9528,6 +9461,50 @@ paths:
       summary: Get a specific transaction
       tags:
       - organization
+  /v1/tlds/:
+    get:
+      description: Retrieves a list of TLD Specifications we have support for
+      operationId: get_tld_specifications_v1_tlds__get
+      parameters:
+      - in: query
+        name: fields
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Fields
+      - in: query
+        name: tlds
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Tlds
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                additionalProperties:
+                  items:
+                    type: object
+                  type: array
+                title: Response Get Tld Specifications V1 Tlds  Get
+                type: object
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Get list of Specifications for all TLDs we support
+      tags:
+      - tld
   /v1/tlds/portfolio:
     get:
       description: Retrieves a list of TLDs we have support for