@opusdns/api 0.270.0 → 0.272.0

package/src/openapi.yaml

@@ -2345,7 +2345,9 @@ components:
               $ref: '#/components/schemas/DnsRrsetCreate'
             type: array
           - type: 'null'
-          description: Override RRsets for this zone
+          description: Override RRsets for this zone. Omit to inherit the template
+            (or leave records unchanged if the template also omits rrsets). Provide
+            an empty list to delete all records.
           title: Rrsets
       required:
       - name
@@ -2377,11 +2379,15 @@ components:
           - type: 'null'
           description: DNSSEC status for all zones
         rrsets:
-          description: DNS record sets to update
-          items:
-            $ref: '#/components/schemas/DnsRrsetCreate'
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/DnsRrsetCreate'
+            type: array
+          - type: 'null'
+          description: DNS record sets to apply to every zone. Omit to leave each
+            zone's RRsets unchanged (useful for bulk DNSSEC toggles). Provide an empty
+            list to delete all records.
           title: Rrsets
-          type: array
       title: DnsZoneUpdateBulkTemplate
       type: object
     DnsZoneUpdateCommand:
@@ -10147,7 +10153,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-04-24-174932
+  version: 2026-04-27-163825
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -19805,156 +19811,6 @@ paths:
       summary: Update organization attributes
       tags:
       - organization
-  /v1/organizations/attributes/{organization_id}:
-    get:
-      description: Retrieves a list of organization attributes for the specified organization
-      operationId: get_attributes_v1_organizations_attributes__organization_id__get
-      parameters:
-      - in: path
-        name: organization_id
-        required: true
-        schema:
-          anyOf:
-          - examples:
-            - organization_01h45ytscbebyvny4gc8cr8ma2
-            format: typeid
-            pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
-            type: string
-            x-typeid-prefix: organization
-          - type: 'null'
-          title: Organization Id
-      - description: Optional list of attribute keys to filter
-        in: query
-        name: keys
-        required: false
-        schema:
-          anyOf:
-          - items:
-              type: string
-            type: array
-          - type: 'null'
-          description: Optional list of attribute keys to filter
-          title: Keys
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                items:
-                  $ref: '#/components/schemas/OrganizationAttributeResponse'
-                title: Response Get Attributes V1 Organizations Attributes  Organization
-                  Id  Get
-                type: array
-          description: Successful Response
-        '401':
-          content:
-            application/problem+json:
-              example:
-                code: ERROR_AUTHENTICATION
-                detail: Additional error context.
-                status: 401
-                title: Authentication Error
-                type: authentication
-              schema:
-                $ref: '#/components/schemas/Problem'
-          description: Unauthorized
-        '403':
-          content:
-            application/problem+json:
-              example:
-                code: ERROR_PERMISSION_DENIED
-                detail: Insufficient permissions to perform this action
-                status: 403
-                title: Permission Denied
-                type: permission-denied
-              schema:
-                $ref: '#/components/schemas/Problem'
-          description: Forbidden
-        '422':
-          content:
-            application/problem+json:
-              schema:
-                $ref: '#/components/schemas/HTTPValidationError'
-          description: Validation Error
-      security:
-      - OAuth2PasswordBearer: []
-      - APIKeyHeader: []
-      summary: List organization attributes
-      tags:
-      - organization
-    patch:
-      description: Updates one or more organization attributes for the specified organization
-      operationId: update_attributes_v1_organizations_attributes__organization_id__patch
-      parameters:
-      - in: path
-        name: organization_id
-        required: true
-        schema:
-          anyOf:
-          - examples:
-            - organization_01h45ytscbebyvny4gc8cr8ma2
-            format: typeid
-            pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
-            type: string
-            x-typeid-prefix: organization
-          - type: 'null'
-          title: Organization Id
-      requestBody:
-        content:
-          application/json:
-            schema:
-              items:
-                $ref: '#/components/schemas/OrganizationAttributeUpdate'
-              title: Attributes
-              type: array
-        required: true
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                items:
-                  $ref: '#/components/schemas/OrganizationAttributeResponse'
-                title: Response Update Attributes V1 Organizations Attributes  Organization
-                  Id  Patch
-                type: array
-          description: Successful Response
-        '401':
-          content:
-            application/problem+json:
-              example:
-                code: ERROR_AUTHENTICATION
-                detail: Additional error context.
-                status: 401
-                title: Authentication Error
-                type: authentication
-              schema:
-                $ref: '#/components/schemas/Problem'
-          description: Unauthorized
-        '403':
-          content:
-            application/problem+json:
-              example:
-                code: ERROR_PERMISSION_DENIED
-                detail: Insufficient permissions to perform this action
-                status: 403
-                title: Permission Denied
-                type: permission-denied
-              schema:
-                $ref: '#/components/schemas/Problem'
-          description: Forbidden
-        '422':
-          content:
-            application/problem+json:
-              schema:
-                $ref: '#/components/schemas/HTTPValidationError'
-          description: Validation Error
-      security:
-      - OAuth2PasswordBearer: []
-      - APIKeyHeader: []
-      summary: Update organization attributes
-      tags:
-      - organization
   /v1/organizations/ip-restrictions:
     get:
       description: 'List all IP restrictions for the organization.
@@ -20557,6 +20413,156 @@ paths:
       summary: Update an organization
       tags:
       - organization
+  /v1/organizations/{organization_id}/attributes:
+    get:
+      description: Retrieves a list of organization attributes for the specified organization
+      operationId: get_attributes_v1_organizations__organization_id__attributes_get
+      parameters:
+      - in: path
+        name: organization_id
+        required: true
+        schema:
+          anyOf:
+          - examples:
+            - organization_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: organization
+          - type: 'null'
+          title: Organization Id
+      - description: Optional list of attribute keys to filter
+        in: query
+        name: keys
+        required: false
+        schema:
+          anyOf:
+          - items:
+              type: string
+            type: array
+          - type: 'null'
+          description: Optional list of attribute keys to filter
+          title: Keys
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                items:
+                  $ref: '#/components/schemas/OrganizationAttributeResponse'
+                title: Response Get Attributes V1 Organizations  Organization Id  Attributes
+                  Get
+                type: array
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '403':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_PERMISSION_DENIED
+                detail: Insufficient permissions to perform this action
+                status: 403
+                title: Permission Denied
+                type: permission-denied
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Forbidden
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: List organization attributes
+      tags:
+      - organization
+    patch:
+      description: Updates one or more organization attributes for the specified organization
+      operationId: update_attributes_v1_organizations__organization_id__attributes_patch
+      parameters:
+      - in: path
+        name: organization_id
+        required: true
+        schema:
+          anyOf:
+          - examples:
+            - organization_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: organization
+          - type: 'null'
+          title: Organization Id
+      requestBody:
+        content:
+          application/json:
+            schema:
+              items:
+                $ref: '#/components/schemas/OrganizationAttributeUpdate'
+              title: Attributes
+              type: array
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                items:
+                  $ref: '#/components/schemas/OrganizationAttributeResponse'
+                title: Response Update Attributes V1 Organizations  Organization Id  Attributes
+                  Patch
+                type: array
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '403':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_PERMISSION_DENIED
+                detail: Insufficient permissions to perform this action
+                status: 403
+                title: Permission Denied
+                type: permission-denied
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Forbidden
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Update organization attributes
+      tags:
+      - organization
   /v1/organizations/{organization_id}/billing/invoices:
     get:
       description: Retrieves a paginated list of all invoices for the organization
@@ -22474,7 +22480,12 @@ tags:
     \ updates. For each zone, whatever rrsets you supply become the zone's rrsets\
     \ \u2014 anything not listed is removed. System-managed record types (SOA, DNSKEY,\
     \ DS) cannot be set via this command. This is also the command to flip DNSSEC\
-    \ on or off across many zones.\n\nPayload: `template` (shared `rrsets` and `dnssec_status`)\
+    \ on or off across many zones.\n\nBoth `rrsets` and `dnssec_status` are partial-update\
+    \ fields:\n\n| Value | Meaning |\n| --- | --- |\n| omitted (in both template and\
+    \ instance) | leave that field unchanged on the zone |\n| `[]` (rrsets only) |\
+    \ delete all records |\n| `[...]` / a status value | replace |\n\nAn instance\
+    \ with neither `rrsets` nor `dnssec_status` (after the template is merged in)\
+    \ is rejected as a no-op.\n\nPayload: `template` (shared `rrsets` and `dnssec_status`)\
     \ + `instances[]` (per-zone overrides).\n\n```json\n{\n  \"command\": \"dns_zone_update_bulk\"\
     ,\n  \"payload\": {\n    \"template\": {\n      \"rrsets\": [\n        {\"name\"\
     : \"@\", \"type\": \"A\", \"ttl\": 300, \"records\": [{\"rdata\": \"203.0.113.10\"\
@@ -22482,35 +22493,39 @@ tags:
     : [\n      { \"name\": \"example.com\" },\n      {\n        \"name\": \"example.net\"\
     ,\n        \"rrsets\": [\n          {\"name\": \"@\", \"type\": \"A\", \"ttl\"\
     : 300, \"records\": [{\"rdata\": \"203.0.113.20\"}]}\n        ]\n      }\n   \
-    \ ]\n  }\n}\n```\n\n#### `dns_zone_patch_rrsets_bulk`\n\nBulk equivalent of `PATCH\
-    \ /v1/dns/{zone_name}/rrsets`. Each instance is `{ zone_name, ops[] }`, where\
-    \ each op targets an rrset by `(name, type)`:\n\n- `op: \"upsert\"` \u2014 create\
-    \ or **replace** the rrset with the records you provide. Any prior records for\
-    \ that `(name, type)` are discarded.\n- `op: \"remove\"` \u2014 delete the entire\
-    \ rrset (pass `records: []`).\n\n```json\n{\n  \"command\": \"dns_zone_patch_rrsets_bulk\"\
-    ,\n  \"payload\": {\n    \"instances\": [\n      {\n        \"zone_name\": \"\
-    example.com\",\n        \"ops\": [\n          {\n            \"op\": \"upsert\"\
-    ,\n            \"rrset\": {\n              \"name\": \"www\", \"type\": \"A\"\
-    , \"ttl\": 300,\n              \"records\": [\n                {\"rdata\": \"\
-    203.0.113.10\"},\n                {\"rdata\": \"203.0.113.11\"}\n            \
-    \  ]\n            }\n          },\n          {\n            \"op\": \"remove\"\
-    ,\n            \"rrset\": {\"name\": \"old\", \"type\": \"CNAME\", \"ttl\": 300,\
-    \ \"records\": []}\n          }\n        ]\n      }\n    ]\n  }\n}\n```\n\n####\
-    \ `dns_zone_patch_records_bulk`\n\nBulk equivalent of `PATCH /v1/dns/{zone_name}/records`.\
-    \ Each instance is `{ zone_name, ops[] }`, where each op targets a single `rdata`\
-    \ value inside an rrset. Note the op payload uses a single `rdata` field, not\
-    \ `records[]`.\n\n- `op: \"upsert\"` \u2014 add or update that one rdata value\
-    \ (creates the rrset if it doesn't exist). Sibling records in the rrset are untouched.\n\
-    - `op: \"remove\"` \u2014 remove just that one rdata value. Other records in the\
-    \ rrset remain.\n\n```json\n{\n  \"command\": \"dns_zone_patch_records_bulk\"\
-    ,\n  \"payload\": {\n    \"instances\": [\n      {\n        \"zone_name\": \"\
-    example.com\",\n        \"ops\": [\n          {\n            \"op\": \"upsert\"\
-    ,\n            \"record\": {\n              \"name\": \"@\", \"type\": \"MX\"\
-    , \"ttl\": 300,\n              \"rdata\": \"5 new-mail.example.com.\"\n      \
-    \      }\n          },\n          {\n            \"op\": \"remove\",\n       \
-    \     \"record\": {\n              \"name\": \"@\", \"type\": \"MX\", \"ttl\"\
-    : 300,\n              \"rdata\": \"10 old-mail.example.com.\"\n            }\n\
-    \          }\n        ]\n      }\n    ]\n  }\n}\n```\n"
+    \ ]\n  }\n}\n```\n\nBulk-toggle DNSSEC across many zones without touching their\
+    \ records \u2014 omit `rrsets` everywhere:\n\n```json\n{\n  \"command\": \"dns_zone_update_bulk\"\
+    ,\n  \"payload\": {\n    \"template\": { \"dnssec_status\": \"enabled\" },\n \
+    \   \"instances\": [\n      { \"name\": \"example.com\" },\n      { \"name\":\
+    \ \"example.net\" },\n      { \"name\": \"example.org\" }\n    ]\n  }\n}\n```\n\
+    \n#### `dns_zone_patch_rrsets_bulk`\n\nBulk equivalent of `PATCH /v1/dns/{zone_name}/rrsets`.\
+    \ Each instance is `{ zone_name, ops[] }`, where each op targets an rrset by `(name,\
+    \ type)`:\n\n- `op: \"upsert\"` \u2014 create or **replace** the rrset with the\
+    \ records you provide. Any prior records for that `(name, type)` are discarded.\n\
+    - `op: \"remove\"` \u2014 delete the entire rrset (pass `records: []`).\n\n```json\n\
+    {\n  \"command\": \"dns_zone_patch_rrsets_bulk\",\n  \"payload\": {\n    \"instances\"\
+    : [\n      {\n        \"zone_name\": \"example.com\",\n        \"ops\": [\n  \
+    \        {\n            \"op\": \"upsert\",\n            \"rrset\": {\n      \
+    \        \"name\": \"www\", \"type\": \"A\", \"ttl\": 300,\n              \"records\"\
+    : [\n                {\"rdata\": \"203.0.113.10\"},\n                {\"rdata\"\
+    : \"203.0.113.11\"}\n              ]\n            }\n          },\n          {\n\
+    \            \"op\": \"remove\",\n            \"rrset\": {\"name\": \"old\", \"\
+    type\": \"CNAME\", \"ttl\": 300, \"records\": []}\n          }\n        ]\n  \
+    \    }\n    ]\n  }\n}\n```\n\n#### `dns_zone_patch_records_bulk`\n\nBulk equivalent\
+    \ of `PATCH /v1/dns/{zone_name}/records`. Each instance is `{ zone_name, ops[]\
+    \ }`, where each op targets a single `rdata` value inside an rrset. Note the op\
+    \ payload uses a single `rdata` field, not `records[]`.\n\n- `op: \"upsert\"`\
+    \ \u2014 add or update that one rdata value (creates the rrset if it doesn't exist).\
+    \ Sibling records in the rrset are untouched.\n- `op: \"remove\"` \u2014 remove\
+    \ just that one rdata value. Other records in the rrset remain.\n\n```json\n{\n\
+    \  \"command\": \"dns_zone_patch_records_bulk\",\n  \"payload\": {\n    \"instances\"\
+    : [\n      {\n        \"zone_name\": \"example.com\",\n        \"ops\": [\n  \
+    \        {\n            \"op\": \"upsert\",\n            \"record\": {\n     \
+    \         \"name\": \"@\", \"type\": \"MX\", \"ttl\": 300,\n              \"rdata\"\
+    : \"5 new-mail.example.com.\"\n            }\n          },\n          {\n    \
+    \        \"op\": \"remove\",\n            \"record\": {\n              \"name\"\
+    : \"@\", \"type\": \"MX\", \"ttl\": 300,\n              \"rdata\": \"10 old-mail.example.com.\"\
+    \n            }\n          }\n        ]\n      }\n    ]\n  }\n}\n```\n"
   name: jobs
   x-displayName: Jobs
 - description: 'Endpoints for creating and managing contacts.