@opusdns/api 0.96.0 → 0.97.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.9.1"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.96.0",
6
+ "version": "0.97.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -1185,7 +1185,7 @@ export type PATCH_DomainForwards_Request_Body = PATCH_DomainForwards_Request['re
1185
1185
  * Use this type to ensure type safety when making API requests to this endpoint.
1186
1186
  *
1187
1187
  * @path /v1/domain-forwards/{hostname}
1188
- * @param hostname (path) - Hostname (trailing dot optional)
1188
+ * @param hostname (path) - Hostname
1189
1189
  *
1190
1190
  * @see {@link DELETE_DomainForwardsHostname_Request_Query} - Query parameters type
1191
1191
  * @see {@link DELETE_DomainForwardsHostname_Request_Path} - Path parameters type
@@ -1207,7 +1207,7 @@ export type DELETE_DomainForwardsHostname_Request = {
1207
1207
  * Use this type to ensure type safety for path parameters.
1208
1208
  *
1209
1209
  * @path /v1/domain-forwards/{hostname}
1210
- * @param hostname (path) - Hostname (trailing dot optional)
1210
+ * @param hostname (path) - Hostname
1211
1211
  */
1212
1212
  export type DELETE_DomainForwardsHostname_Request_Path = DELETE_DomainForwardsHostname_Request['parameters']['path'];
1213
1213
 
@@ -1226,7 +1226,7 @@ export type DELETE_DomainForwardsHostname_Request_Path = DELETE_DomainForwardsHo
1226
1226
  * Use this type to ensure type safety when making API requests to this endpoint.
1227
1227
  *
1228
1228
  * @path /v1/domain-forwards/{hostname}
1229
- * @param hostname (path) - Hostname (trailing dot optional)
1229
+ * @param hostname (path) - Hostname
1230
1230
  *
1231
1231
  * @see {@link GET_DomainForwardsHostname_Request_Query} - Query parameters type
1232
1232
  * @see {@link GET_DomainForwardsHostname_Request_Path} - Path parameters type
@@ -1248,7 +1248,7 @@ export type GET_DomainForwardsHostname_Request = {
1248
1248
  * Use this type to ensure type safety for path parameters.
1249
1249
  *
1250
1250
  * @path /v1/domain-forwards/{hostname}
1251
- * @param hostname (path) - Hostname (trailing dot optional)
1251
+ * @param hostname (path) - Hostname
1252
1252
  */
1253
1253
  export type GET_DomainForwardsHostname_Request_Path = GET_DomainForwardsHostname_Request['parameters']['path'];
1254
1254
 
@@ -1267,7 +1267,7 @@ export type GET_DomainForwardsHostname_Request_Path = GET_DomainForwardsHostname
1267
1267
  * Use this type to ensure type safety when making API requests to this endpoint.
1268
1268
  *
1269
1269
  * @path /v1/domain-forwards/{hostname}
1270
- * @param hostname (path) - Hostname (trailing dot optional)
1270
+ * @param hostname (path) - Hostname
1271
1271
  *
1272
1272
  * @see {@link POST_DomainForwardsHostname_Request_Query} - Query parameters type
1273
1273
  * @see {@link POST_DomainForwardsHostname_Request_Path} - Path parameters type
@@ -1290,7 +1290,7 @@ export type POST_DomainForwardsHostname_Request = {
1290
1290
  * Use this type to ensure type safety for path parameters.
1291
1291
  *
1292
1292
  * @path /v1/domain-forwards/{hostname}
1293
- * @param hostname (path) - Hostname (trailing dot optional)
1293
+ * @param hostname (path) - Hostname
1294
1294
  */
1295
1295
  export type POST_DomainForwardsHostname_Request_Path = POST_DomainForwardsHostname_Request['parameters']['path'];
1296
1296
  /**
@@ -1322,7 +1322,7 @@ export type POST_DomainForwardsHostname_Request_Body = POST_DomainForwardsHostna
1322
1322
  * Use this type to ensure type safety when making API requests to this endpoint.
1323
1323
  *
1324
1324
  * @path /v1/domain-forwards/{hostname}/disable
1325
- * @param hostname (path) - Hostname (trailing dot optional)
1325
+ * @param hostname (path) - Hostname
1326
1326
  *
1327
1327
  * @see {@link PATCH_DomainForwardsHostnameDisable_Request_Query} - Query parameters type
1328
1328
  * @see {@link PATCH_DomainForwardsHostnameDisable_Request_Path} - Path parameters type
@@ -1344,7 +1344,7 @@ export type PATCH_DomainForwardsHostnameDisable_Request = {
1344
1344
  * Use this type to ensure type safety for path parameters.
1345
1345
  *
1346
1346
  * @path /v1/domain-forwards/{hostname}/disable
1347
- * @param hostname (path) - Hostname (trailing dot optional)
1347
+ * @param hostname (path) - Hostname
1348
1348
  */
1349
1349
  export type PATCH_DomainForwardsHostnameDisable_Request_Path = PATCH_DomainForwardsHostnameDisable_Request['parameters']['path'];
1350
1350
 
@@ -1363,7 +1363,7 @@ export type PATCH_DomainForwardsHostnameDisable_Request_Path = PATCH_DomainForwa
1363
1363
  * Use this type to ensure type safety when making API requests to this endpoint.
1364
1364
  *
1365
1365
  * @path /v1/domain-forwards/{hostname}/enable
1366
- * @param hostname (path) - Hostname (trailing dot optional)
1366
+ * @param hostname (path) - Hostname
1367
1367
  * @param auto_create_zone (query) - Auto create zone if it doesn't exist
1368
1368
  * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
1369
1369
  * @param wildcard (query) - Wildcard domain forwarding
@@ -1405,7 +1405,7 @@ export type PATCH_DomainForwardsHostnameEnable_Request_Query = PATCH_DomainForwa
1405
1405
  * Use this type to ensure type safety for path parameters.
1406
1406
  *
1407
1407
  * @path /v1/domain-forwards/{hostname}/enable
1408
- * @param hostname (path) - Hostname (trailing dot optional)
1408
+ * @param hostname (path) - Hostname
1409
1409
  */
1410
1410
  export type PATCH_DomainForwardsHostnameEnable_Request_Path = PATCH_DomainForwardsHostnameEnable_Request['parameters']['path'];
1411
1411
 
@@ -1424,7 +1424,7 @@ export type PATCH_DomainForwardsHostnameEnable_Request_Path = PATCH_DomainForwar
1424
1424
  * Use this type to ensure type safety when making API requests to this endpoint.
1425
1425
  *
1426
1426
  * @path /v1/domain-forwards/{hostname}/{protocol}
1427
- * @param hostname (path) - Hostname (trailing dot optional)
1427
+ * @param hostname (path) - Hostname
1428
1428
  *
1429
1429
  * @see {@link DELETE_DomainForwardsHostnameProtocol_Request_Query} - Query parameters type
1430
1430
  * @see {@link DELETE_DomainForwardsHostnameProtocol_Request_Path} - Path parameters type
@@ -1446,7 +1446,7 @@ export type DELETE_DomainForwardsHostnameProtocol_Request = {
1446
1446
  * Use this type to ensure type safety for path parameters.
1447
1447
  *
1448
1448
  * @path /v1/domain-forwards/{hostname}/{protocol}
1449
- * @param hostname (path) - Hostname (trailing dot optional)
1449
+ * @param hostname (path) - Hostname
1450
1450
  */
1451
1451
  export type DELETE_DomainForwardsHostnameProtocol_Request_Path = DELETE_DomainForwardsHostnameProtocol_Request['parameters']['path'];
1452
1452
 
@@ -1465,7 +1465,7 @@ export type DELETE_DomainForwardsHostnameProtocol_Request_Path = DELETE_DomainFo
1465
1465
  * Use this type to ensure type safety when making API requests to this endpoint.
1466
1466
  *
1467
1467
  * @path /v1/domain-forwards/{hostname}/{protocol}
1468
- * @param hostname (path) - Hostname (trailing dot optional)
1468
+ * @param hostname (path) - Hostname
1469
1469
  *
1470
1470
  * @see {@link GET_DomainForwardsHostnameProtocol_Request_Query} - Query parameters type
1471
1471
  * @see {@link GET_DomainForwardsHostnameProtocol_Request_Path} - Path parameters type
@@ -1487,7 +1487,7 @@ export type GET_DomainForwardsHostnameProtocol_Request = {
1487
1487
  * Use this type to ensure type safety for path parameters.
1488
1488
  *
1489
1489
  * @path /v1/domain-forwards/{hostname}/{protocol}
1490
- * @param hostname (path) - Hostname (trailing dot optional)
1490
+ * @param hostname (path) - Hostname
1491
1491
  */
1492
1492
  export type GET_DomainForwardsHostnameProtocol_Request_Path = GET_DomainForwardsHostnameProtocol_Request['parameters']['path'];
1493
1493
 
@@ -1506,7 +1506,7 @@ export type GET_DomainForwardsHostnameProtocol_Request_Path = GET_DomainForwards
1506
1506
  * Use this type to ensure type safety when making API requests to this endpoint.
1507
1507
  *
1508
1508
  * @path /v1/domain-forwards/{hostname}/{protocol}
1509
- * @param hostname (path) - Hostname (trailing dot optional)
1509
+ * @param hostname (path) - Hostname
1510
1510
  *
1511
1511
  * @see {@link POST_DomainForwardsHostnameProtocol_Request_Query} - Query parameters type
1512
1512
  * @see {@link POST_DomainForwardsHostnameProtocol_Request_Path} - Path parameters type
@@ -1529,7 +1529,7 @@ export type POST_DomainForwardsHostnameProtocol_Request = {
1529
1529
  * Use this type to ensure type safety for path parameters.
1530
1530
  *
1531
1531
  * @path /v1/domain-forwards/{hostname}/{protocol}
1532
- * @param hostname (path) - Hostname (trailing dot optional)
1532
+ * @param hostname (path) - Hostname
1533
1533
  */
1534
1534
  export type POST_DomainForwardsHostnameProtocol_Request_Path = POST_DomainForwardsHostnameProtocol_Request['parameters']['path'];
1535
1535
  /**
@@ -1561,7 +1561,7 @@ export type POST_DomainForwardsHostnameProtocol_Request_Body = POST_DomainForwar
1561
1561
  * Use this type to ensure type safety when making API requests to this endpoint.
1562
1562
  *
1563
1563
  * @path /v1/domain-forwards/{hostname}/{protocol}
1564
- * @param hostname (path) - Hostname (trailing dot optional)
1564
+ * @param hostname (path) - Hostname
1565
1565
  *
1566
1566
  * @see {@link PUT_DomainForwardsHostnameProtocol_Request_Query} - Query parameters type
1567
1567
  * @see {@link PUT_DomainForwardsHostnameProtocol_Request_Path} - Path parameters type
@@ -1584,7 +1584,7 @@ export type PUT_DomainForwardsHostnameProtocol_Request = {
1584
1584
  * Use this type to ensure type safety for path parameters.
1585
1585
  *
1586
1586
  * @path /v1/domain-forwards/{hostname}/{protocol}
1587
- * @param hostname (path) - Hostname (trailing dot optional)
1587
+ * @param hostname (path) - Hostname
1588
1588
  */
1589
1589
  export type PUT_DomainForwardsHostnameProtocol_Request_Path = PUT_DomainForwardsHostnameProtocol_Request['parameters']['path'];
1590
1590
  /**
@@ -2048,7 +2048,7 @@ export type PATCH_DomainForwards_Response_422 = HTTPValidationError
2048
2048
 
2049
2049
  *
2050
2050
  * @path /v1/domain-forwards/{hostname}
2051
- * @param hostname (path) - Hostname (trailing dot optional)
2051
+ * @param hostname (path) - Hostname
2052
2052
  *
2053
2053
  * @see {@link DELETE_DomainForwardsByHostname_Response_401} - 401 response type
2054
2054
  * @see {@link DELETE_DomainForwardsByHostname_Response_403} - 403 response type
@@ -2070,7 +2070,7 @@ export type DELETE_DomainForwardsByHostname_Response = DELETE_DomainForwardsByHo
2070
2070
 
2071
2071
  *
2072
2072
  * @path /v1/domain-forwards/{hostname}
2073
- * @param hostname (path) - Hostname (trailing dot optional)
2073
+ * @param hostname (path) - Hostname
2074
2074
  *
2075
2075
  * @see {@link DELETE_DomainForwardsByHostname_Response} - The main response type definition
2076
2076
  * @see {@link Problem} - The actual schema type definition
@@ -2088,7 +2088,7 @@ export type DELETE_DomainForwardsByHostname_Response_401 = Problem
2088
2088
 
2089
2089
  *
2090
2090
  * @path /v1/domain-forwards/{hostname}
2091
- * @param hostname (path) - Hostname (trailing dot optional)
2091
+ * @param hostname (path) - Hostname
2092
2092
  *
2093
2093
  * @see {@link DELETE_DomainForwardsByHostname_Response} - The main response type definition
2094
2094
  * @see {@link Problem} - The actual schema type definition
@@ -2106,7 +2106,7 @@ export type DELETE_DomainForwardsByHostname_Response_403 = Problem
2106
2106
 
2107
2107
  *
2108
2108
  * @path /v1/domain-forwards/{hostname}
2109
- * @param hostname (path) - Hostname (trailing dot optional)
2109
+ * @param hostname (path) - Hostname
2110
2110
  *
2111
2111
  * @see {@link DELETE_DomainForwardsByHostname_Response} - The main response type definition
2112
2112
  * @see {@link Problem} - The actual schema type definition
@@ -2124,7 +2124,7 @@ export type DELETE_DomainForwardsByHostname_Response_404 = Problem
2124
2124
 
2125
2125
  *
2126
2126
  * @path /v1/domain-forwards/{hostname}
2127
- * @param hostname (path) - Hostname (trailing dot optional)
2127
+ * @param hostname (path) - Hostname
2128
2128
  *
2129
2129
  * @see {@link DELETE_DomainForwardsByHostname_Response} - The main response type definition
2130
2130
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -2145,7 +2145,7 @@ export type DELETE_DomainForwardsByHostname_Response_422 = HTTPValidationError
2145
2145
 
2146
2146
  *
2147
2147
  * @path /v1/domain-forwards/{hostname}
2148
- * @param hostname (path) - Hostname (trailing dot optional)
2148
+ * @param hostname (path) - Hostname
2149
2149
  *
2150
2150
  * @see {@link GET_DomainForwardsByHostname_Response_200} - 200 response type
2151
2151
  * @see {@link GET_DomainForwardsByHostname_Response_401} - 401 response type
@@ -2168,7 +2168,7 @@ export type GET_DomainForwardsByHostname_Response = GET_DomainForwardsByHostname
2168
2168
 
2169
2169
  *
2170
2170
  * @path /v1/domain-forwards/{hostname}
2171
- * @param hostname (path) - Hostname (trailing dot optional)
2171
+ * @param hostname (path) - Hostname
2172
2172
  *
2173
2173
  * @see {@link GET_DomainForwardsByHostname_Response} - The main response type definition
2174
2174
  * @see {@link DomainForward} - The actual schema type definition
@@ -2186,7 +2186,7 @@ export type GET_DomainForwardsByHostname_Response_200 = DomainForward
2186
2186
 
2187
2187
  *
2188
2188
  * @path /v1/domain-forwards/{hostname}
2189
- * @param hostname (path) - Hostname (trailing dot optional)
2189
+ * @param hostname (path) - Hostname
2190
2190
  *
2191
2191
  * @see {@link GET_DomainForwardsByHostname_Response} - The main response type definition
2192
2192
  * @see {@link Problem} - The actual schema type definition
@@ -2204,7 +2204,7 @@ export type GET_DomainForwardsByHostname_Response_401 = Problem
2204
2204
 
2205
2205
  *
2206
2206
  * @path /v1/domain-forwards/{hostname}
2207
- * @param hostname (path) - Hostname (trailing dot optional)
2207
+ * @param hostname (path) - Hostname
2208
2208
  *
2209
2209
  * @see {@link GET_DomainForwardsByHostname_Response} - The main response type definition
2210
2210
  * @see {@link Problem} - The actual schema type definition
@@ -2222,7 +2222,7 @@ export type GET_DomainForwardsByHostname_Response_403 = Problem
2222
2222
 
2223
2223
  *
2224
2224
  * @path /v1/domain-forwards/{hostname}
2225
- * @param hostname (path) - Hostname (trailing dot optional)
2225
+ * @param hostname (path) - Hostname
2226
2226
  *
2227
2227
  * @see {@link GET_DomainForwardsByHostname_Response} - The main response type definition
2228
2228
  * @see {@link Problem} - The actual schema type definition
@@ -2240,7 +2240,7 @@ export type GET_DomainForwardsByHostname_Response_404 = Problem
2240
2240
 
2241
2241
  *
2242
2242
  * @path /v1/domain-forwards/{hostname}
2243
- * @param hostname (path) - Hostname (trailing dot optional)
2243
+ * @param hostname (path) - Hostname
2244
2244
  *
2245
2245
  * @see {@link GET_DomainForwardsByHostname_Response} - The main response type definition
2246
2246
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -2261,17 +2261,18 @@ export type GET_DomainForwardsByHostname_Response_422 = HTTPValidationError
2261
2261
 
2262
2262
  *
2263
2263
  * @path /v1/domain-forwards/{hostname}
2264
- * @param hostname (path) - Hostname (trailing dot optional)
2264
+ * @param hostname (path) - Hostname
2265
2265
  *
2266
2266
  * @see {@link POST_DomainForwardsByHostname_Response_201} - 201 response type
2267
2267
  * @see {@link POST_DomainForwardsByHostname_Response_401} - 401 response type
2268
2268
  * @see {@link POST_DomainForwardsByHostname_Response_403} - 403 response type
2269
+ * @see {@link POST_DomainForwardsByHostname_Response_404} - 404 response type
2269
2270
  * @see {@link POST_DomainForwardsByHostname_Response_409} - 409 response type
2270
2271
  * @see {@link POST_DomainForwardsByHostname_Response_422} - 422 response type
2271
2272
  *
2272
2273
 
2273
2274
  */
2274
- export type POST_DomainForwardsByHostname_Response = POST_DomainForwardsByHostname_Response_201 | POST_DomainForwardsByHostname_Response_401 | POST_DomainForwardsByHostname_Response_403 | POST_DomainForwardsByHostname_Response_409 | POST_DomainForwardsByHostname_Response_422;
2275
+ export type POST_DomainForwardsByHostname_Response = POST_DomainForwardsByHostname_Response_201 | POST_DomainForwardsByHostname_Response_401 | POST_DomainForwardsByHostname_Response_403 | POST_DomainForwardsByHostname_Response_404 | POST_DomainForwardsByHostname_Response_409 | POST_DomainForwardsByHostname_Response_422;
2275
2276
 
2276
2277
  /**
2277
2278
  * 201 response for POST DomainForwardsByHostname endpoint
@@ -2284,7 +2285,7 @@ export type POST_DomainForwardsByHostname_Response = POST_DomainForwardsByHostna
2284
2285
 
2285
2286
  *
2286
2287
  * @path /v1/domain-forwards/{hostname}
2287
- * @param hostname (path) - Hostname (trailing dot optional)
2288
+ * @param hostname (path) - Hostname
2288
2289
  *
2289
2290
  * @see {@link POST_DomainForwardsByHostname_Response} - The main response type definition
2290
2291
  * @see {@link DomainForward} - The actual schema type definition
@@ -2302,7 +2303,7 @@ export type POST_DomainForwardsByHostname_Response_201 = DomainForward
2302
2303
 
2303
2304
  *
2304
2305
  * @path /v1/domain-forwards/{hostname}
2305
- * @param hostname (path) - Hostname (trailing dot optional)
2306
+ * @param hostname (path) - Hostname
2306
2307
  *
2307
2308
  * @see {@link POST_DomainForwardsByHostname_Response} - The main response type definition
2308
2309
  * @see {@link Problem} - The actual schema type definition
@@ -2320,13 +2321,31 @@ export type POST_DomainForwardsByHostname_Response_401 = Problem
2320
2321
 
2321
2322
  *
2322
2323
  * @path /v1/domain-forwards/{hostname}
2323
- * @param hostname (path) - Hostname (trailing dot optional)
2324
+ * @param hostname (path) - Hostname
2324
2325
  *
2325
2326
  * @see {@link POST_DomainForwardsByHostname_Response} - The main response type definition
2326
2327
  * @see {@link Problem} - The actual schema type definition
2327
2328
  */
2328
2329
  export type POST_DomainForwardsByHostname_Response_403 = Problem
2329
2330
 
2331
+ /**
2332
+ * 404 response for POST DomainForwardsByHostname endpoint
2333
+ *
2334
+ * @remarks
2335
+ * This type defines the response structure for the 404 status code
2336
+ * of the POST DomainForwardsByHostname endpoint.
2337
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
2338
+ *
2339
+
2340
+ *
2341
+ * @path /v1/domain-forwards/{hostname}
2342
+ * @param hostname (path) - Hostname
2343
+ *
2344
+ * @see {@link POST_DomainForwardsByHostname_Response} - The main response type definition
2345
+ * @see {@link Problem} - The actual schema type definition
2346
+ */
2347
+ export type POST_DomainForwardsByHostname_Response_404 = Problem
2348
+
2330
2349
  /**
2331
2350
  * 409 response for POST DomainForwardsByHostname endpoint
2332
2351
  *
@@ -2338,7 +2357,7 @@ export type POST_DomainForwardsByHostname_Response_403 = Problem
2338
2357
 
2339
2358
  *
2340
2359
  * @path /v1/domain-forwards/{hostname}
2341
- * @param hostname (path) - Hostname (trailing dot optional)
2360
+ * @param hostname (path) - Hostname
2342
2361
  *
2343
2362
  * @see {@link POST_DomainForwardsByHostname_Response} - The main response type definition
2344
2363
  * @see {@link Problem} - The actual schema type definition
@@ -2356,7 +2375,7 @@ export type POST_DomainForwardsByHostname_Response_409 = Problem
2356
2375
 
2357
2376
  *
2358
2377
  * @path /v1/domain-forwards/{hostname}
2359
- * @param hostname (path) - Hostname (trailing dot optional)
2378
+ * @param hostname (path) - Hostname
2360
2379
  *
2361
2380
  * @see {@link POST_DomainForwardsByHostname_Response} - The main response type definition
2362
2381
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -2377,7 +2396,7 @@ export type POST_DomainForwardsByHostname_Response_422 = HTTPValidationError
2377
2396
 
2378
2397
  *
2379
2398
  * @path /v1/domain-forwards/{hostname}/{protocol}
2380
- * @param hostname (path) - Hostname (trailing dot optional)
2399
+ * @param hostname (path) - Hostname
2381
2400
  *
2382
2401
  * @see {@link DELETE_DomainForwardsByHostnameByProtocol_Response_401} - 401 response type
2383
2402
  * @see {@link DELETE_DomainForwardsByHostnameByProtocol_Response_403} - 403 response type
@@ -2399,7 +2418,7 @@ export type DELETE_DomainForwardsByHostnameByProtocol_Response = DELETE_DomainFo
2399
2418
 
2400
2419
  *
2401
2420
  * @path /v1/domain-forwards/{hostname}/{protocol}
2402
- * @param hostname (path) - Hostname (trailing dot optional)
2421
+ * @param hostname (path) - Hostname
2403
2422
  *
2404
2423
  * @see {@link DELETE_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2405
2424
  * @see {@link Problem} - The actual schema type definition
@@ -2417,7 +2436,7 @@ export type DELETE_DomainForwardsByHostnameByProtocol_Response_401 = Problem
2417
2436
 
2418
2437
  *
2419
2438
  * @path /v1/domain-forwards/{hostname}/{protocol}
2420
- * @param hostname (path) - Hostname (trailing dot optional)
2439
+ * @param hostname (path) - Hostname
2421
2440
  *
2422
2441
  * @see {@link DELETE_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2423
2442
  * @see {@link Problem} - The actual schema type definition
@@ -2435,7 +2454,7 @@ export type DELETE_DomainForwardsByHostnameByProtocol_Response_403 = Problem
2435
2454
 
2436
2455
  *
2437
2456
  * @path /v1/domain-forwards/{hostname}/{protocol}
2438
- * @param hostname (path) - Hostname (trailing dot optional)
2457
+ * @param hostname (path) - Hostname
2439
2458
  *
2440
2459
  * @see {@link DELETE_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2441
2460
  * @see {@link Problem} - The actual schema type definition
@@ -2453,7 +2472,7 @@ export type DELETE_DomainForwardsByHostnameByProtocol_Response_404 = Problem
2453
2472
 
2454
2473
  *
2455
2474
  * @path /v1/domain-forwards/{hostname}/{protocol}
2456
- * @param hostname (path) - Hostname (trailing dot optional)
2475
+ * @param hostname (path) - Hostname
2457
2476
  *
2458
2477
  * @see {@link DELETE_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2459
2478
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -2474,7 +2493,7 @@ export type DELETE_DomainForwardsByHostnameByProtocol_Response_422 = HTTPValidat
2474
2493
 
2475
2494
  *
2476
2495
  * @path /v1/domain-forwards/{hostname}/{protocol}
2477
- * @param hostname (path) - Hostname (trailing dot optional)
2496
+ * @param hostname (path) - Hostname
2478
2497
  *
2479
2498
  * @see {@link GET_DomainForwardsByHostnameByProtocol_Response_200} - 200 response type
2480
2499
  * @see {@link GET_DomainForwardsByHostnameByProtocol_Response_401} - 401 response type
@@ -2497,7 +2516,7 @@ export type GET_DomainForwardsByHostnameByProtocol_Response = GET_DomainForwards
2497
2516
 
2498
2517
  *
2499
2518
  * @path /v1/domain-forwards/{hostname}/{protocol}
2500
- * @param hostname (path) - Hostname (trailing dot optional)
2519
+ * @param hostname (path) - Hostname
2501
2520
  *
2502
2521
  * @see {@link GET_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2503
2522
  * @see {@link DomainForwardSet} - The actual schema type definition
@@ -2515,7 +2534,7 @@ export type GET_DomainForwardsByHostnameByProtocol_Response_200 = DomainForwardS
2515
2534
 
2516
2535
  *
2517
2536
  * @path /v1/domain-forwards/{hostname}/{protocol}
2518
- * @param hostname (path) - Hostname (trailing dot optional)
2537
+ * @param hostname (path) - Hostname
2519
2538
  *
2520
2539
  * @see {@link GET_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2521
2540
  * @see {@link Problem} - The actual schema type definition
@@ -2533,7 +2552,7 @@ export type GET_DomainForwardsByHostnameByProtocol_Response_401 = Problem
2533
2552
 
2534
2553
  *
2535
2554
  * @path /v1/domain-forwards/{hostname}/{protocol}
2536
- * @param hostname (path) - Hostname (trailing dot optional)
2555
+ * @param hostname (path) - Hostname
2537
2556
  *
2538
2557
  * @see {@link GET_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2539
2558
  * @see {@link Problem} - The actual schema type definition
@@ -2551,7 +2570,7 @@ export type GET_DomainForwardsByHostnameByProtocol_Response_403 = Problem
2551
2570
 
2552
2571
  *
2553
2572
  * @path /v1/domain-forwards/{hostname}/{protocol}
2554
- * @param hostname (path) - Hostname (trailing dot optional)
2573
+ * @param hostname (path) - Hostname
2555
2574
  *
2556
2575
  * @see {@link GET_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2557
2576
  * @see {@link Problem} - The actual schema type definition
@@ -2569,7 +2588,7 @@ export type GET_DomainForwardsByHostnameByProtocol_Response_404 = Problem
2569
2588
 
2570
2589
  *
2571
2590
  * @path /v1/domain-forwards/{hostname}/{protocol}
2572
- * @param hostname (path) - Hostname (trailing dot optional)
2591
+ * @param hostname (path) - Hostname
2573
2592
  *
2574
2593
  * @see {@link GET_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2575
2594
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -2590,7 +2609,7 @@ export type GET_DomainForwardsByHostnameByProtocol_Response_422 = HTTPValidation
2590
2609
 
2591
2610
  *
2592
2611
  * @path /v1/domain-forwards/{hostname}/{protocol}
2593
- * @param hostname (path) - Hostname (trailing dot optional)
2612
+ * @param hostname (path) - Hostname
2594
2613
  *
2595
2614
  * @see {@link POST_DomainForwardsByHostnameByProtocol_Response_201} - 201 response type
2596
2615
  * @see {@link POST_DomainForwardsByHostnameByProtocol_Response_401} - 401 response type
@@ -2614,7 +2633,7 @@ export type POST_DomainForwardsByHostnameByProtocol_Response = POST_DomainForwar
2614
2633
 
2615
2634
  *
2616
2635
  * @path /v1/domain-forwards/{hostname}/{protocol}
2617
- * @param hostname (path) - Hostname (trailing dot optional)
2636
+ * @param hostname (path) - Hostname
2618
2637
  *
2619
2638
  * @see {@link POST_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2620
2639
  * @see {@link DomainForwardSet} - The actual schema type definition
@@ -2632,7 +2651,7 @@ export type POST_DomainForwardsByHostnameByProtocol_Response_201 = DomainForward
2632
2651
 
2633
2652
  *
2634
2653
  * @path /v1/domain-forwards/{hostname}/{protocol}
2635
- * @param hostname (path) - Hostname (trailing dot optional)
2654
+ * @param hostname (path) - Hostname
2636
2655
  *
2637
2656
  * @see {@link POST_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2638
2657
  * @see {@link Problem} - The actual schema type definition
@@ -2650,7 +2669,7 @@ export type POST_DomainForwardsByHostnameByProtocol_Response_401 = Problem
2650
2669
 
2651
2670
  *
2652
2671
  * @path /v1/domain-forwards/{hostname}/{protocol}
2653
- * @param hostname (path) - Hostname (trailing dot optional)
2672
+ * @param hostname (path) - Hostname
2654
2673
  *
2655
2674
  * @see {@link POST_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2656
2675
  * @see {@link Problem} - The actual schema type definition
@@ -2668,7 +2687,7 @@ export type POST_DomainForwardsByHostnameByProtocol_Response_403 = Problem
2668
2687
 
2669
2688
  *
2670
2689
  * @path /v1/domain-forwards/{hostname}/{protocol}
2671
- * @param hostname (path) - Hostname (trailing dot optional)
2690
+ * @param hostname (path) - Hostname
2672
2691
  *
2673
2692
  * @see {@link POST_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2674
2693
  * @see {@link Problem} - The actual schema type definition
@@ -2686,7 +2705,7 @@ export type POST_DomainForwardsByHostnameByProtocol_Response_404 = Problem
2686
2705
 
2687
2706
  *
2688
2707
  * @path /v1/domain-forwards/{hostname}/{protocol}
2689
- * @param hostname (path) - Hostname (trailing dot optional)
2708
+ * @param hostname (path) - Hostname
2690
2709
  *
2691
2710
  * @see {@link POST_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2692
2711
  * @see {@link Problem} - The actual schema type definition
@@ -2704,7 +2723,7 @@ export type POST_DomainForwardsByHostnameByProtocol_Response_409 = Problem
2704
2723
 
2705
2724
  *
2706
2725
  * @path /v1/domain-forwards/{hostname}/{protocol}
2707
- * @param hostname (path) - Hostname (trailing dot optional)
2726
+ * @param hostname (path) - Hostname
2708
2727
  *
2709
2728
  * @see {@link POST_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2710
2729
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -2725,7 +2744,7 @@ export type POST_DomainForwardsByHostnameByProtocol_Response_422 = HTTPValidatio
2725
2744
 
2726
2745
  *
2727
2746
  * @path /v1/domain-forwards/{hostname}/{protocol}
2728
- * @param hostname (path) - Hostname (trailing dot optional)
2747
+ * @param hostname (path) - Hostname
2729
2748
  *
2730
2749
  * @see {@link PUT_DomainForwardsByHostnameByProtocol_Response_200} - 200 response type
2731
2750
  * @see {@link PUT_DomainForwardsByHostnameByProtocol_Response_401} - 401 response type
@@ -2748,7 +2767,7 @@ export type PUT_DomainForwardsByHostnameByProtocol_Response = PUT_DomainForwards
2748
2767
 
2749
2768
  *
2750
2769
  * @path /v1/domain-forwards/{hostname}/{protocol}
2751
- * @param hostname (path) - Hostname (trailing dot optional)
2770
+ * @param hostname (path) - Hostname
2752
2771
  *
2753
2772
  * @see {@link PUT_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2754
2773
  * @see {@link DomainForwardSet} - The actual schema type definition
@@ -2766,7 +2785,7 @@ export type PUT_DomainForwardsByHostnameByProtocol_Response_200 = DomainForwardS
2766
2785
 
2767
2786
  *
2768
2787
  * @path /v1/domain-forwards/{hostname}/{protocol}
2769
- * @param hostname (path) - Hostname (trailing dot optional)
2788
+ * @param hostname (path) - Hostname
2770
2789
  *
2771
2790
  * @see {@link PUT_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2772
2791
  * @see {@link Problem} - The actual schema type definition
@@ -2784,7 +2803,7 @@ export type PUT_DomainForwardsByHostnameByProtocol_Response_401 = Problem
2784
2803
 
2785
2804
  *
2786
2805
  * @path /v1/domain-forwards/{hostname}/{protocol}
2787
- * @param hostname (path) - Hostname (trailing dot optional)
2806
+ * @param hostname (path) - Hostname
2788
2807
  *
2789
2808
  * @see {@link PUT_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2790
2809
  * @see {@link Problem} - The actual schema type definition
@@ -2802,7 +2821,7 @@ export type PUT_DomainForwardsByHostnameByProtocol_Response_403 = Problem
2802
2821
 
2803
2822
  *
2804
2823
  * @path /v1/domain-forwards/{hostname}/{protocol}
2805
- * @param hostname (path) - Hostname (trailing dot optional)
2824
+ * @param hostname (path) - Hostname
2806
2825
  *
2807
2826
  * @see {@link PUT_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2808
2827
  * @see {@link Problem} - The actual schema type definition
@@ -2820,7 +2839,7 @@ export type PUT_DomainForwardsByHostnameByProtocol_Response_404 = Problem
2820
2839
 
2821
2840
  *
2822
2841
  * @path /v1/domain-forwards/{hostname}/{protocol}
2823
- * @param hostname (path) - Hostname (trailing dot optional)
2842
+ * @param hostname (path) - Hostname
2824
2843
  *
2825
2844
  * @see {@link PUT_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
2826
2845
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -2841,7 +2860,7 @@ export type PUT_DomainForwardsByHostnameByProtocol_Response_422 = HTTPValidation
2841
2860
 
2842
2861
  *
2843
2862
  * @path /v1/domain-forwards/{hostname}/disable
2844
- * @param hostname (path) - Hostname (trailing dot optional)
2863
+ * @param hostname (path) - Hostname
2845
2864
  *
2846
2865
  * @see {@link PATCH_DomainForwardsByHostnameDisable_Response_401} - 401 response type
2847
2866
  * @see {@link PATCH_DomainForwardsByHostnameDisable_Response_403} - 403 response type
@@ -2862,7 +2881,7 @@ export type PATCH_DomainForwardsByHostnameDisable_Response = PATCH_DomainForward
2862
2881
 
2863
2882
  *
2864
2883
  * @path /v1/domain-forwards/{hostname}/disable
2865
- * @param hostname (path) - Hostname (trailing dot optional)
2884
+ * @param hostname (path) - Hostname
2866
2885
  *
2867
2886
  * @see {@link PATCH_DomainForwardsByHostnameDisable_Response} - The main response type definition
2868
2887
  * @see {@link Problem} - The actual schema type definition
@@ -2880,7 +2899,7 @@ export type PATCH_DomainForwardsByHostnameDisable_Response_401 = Problem
2880
2899
 
2881
2900
  *
2882
2901
  * @path /v1/domain-forwards/{hostname}/disable
2883
- * @param hostname (path) - Hostname (trailing dot optional)
2902
+ * @param hostname (path) - Hostname
2884
2903
  *
2885
2904
  * @see {@link PATCH_DomainForwardsByHostnameDisable_Response} - The main response type definition
2886
2905
  * @see {@link Problem} - The actual schema type definition
@@ -2898,7 +2917,7 @@ export type PATCH_DomainForwardsByHostnameDisable_Response_403 = Problem
2898
2917
 
2899
2918
  *
2900
2919
  * @path /v1/domain-forwards/{hostname}/disable
2901
- * @param hostname (path) - Hostname (trailing dot optional)
2920
+ * @param hostname (path) - Hostname
2902
2921
  *
2903
2922
  * @see {@link PATCH_DomainForwardsByHostnameDisable_Response} - The main response type definition
2904
2923
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -2919,7 +2938,7 @@ export type PATCH_DomainForwardsByHostnameDisable_Response_422 = HTTPValidationE
2919
2938
 
2920
2939
  *
2921
2940
  * @path /v1/domain-forwards/{hostname}/enable
2922
- * @param hostname (path) - Hostname (trailing dot optional)
2941
+ * @param hostname (path) - Hostname
2923
2942
  * @param auto_create_zone (query) - Auto create zone if it doesn't exist
2924
2943
  * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
2925
2944
  * @param wildcard (query) - Wildcard domain forwarding
@@ -2944,7 +2963,7 @@ export type PATCH_DomainForwardsByHostnameEnable_Response = PATCH_DomainForwards
2944
2963
 
2945
2964
  *
2946
2965
  * @path /v1/domain-forwards/{hostname}/enable
2947
- * @param hostname (path) - Hostname (trailing dot optional)
2966
+ * @param hostname (path) - Hostname
2948
2967
  * @param auto_create_zone (query) - Auto create zone if it doesn't exist
2949
2968
  * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
2950
2969
  * @param wildcard (query) - Wildcard domain forwarding
@@ -2965,7 +2984,7 @@ export type PATCH_DomainForwardsByHostnameEnable_Response_400 = Problem
2965
2984
 
2966
2985
  *
2967
2986
  * @path /v1/domain-forwards/{hostname}/enable
2968
- * @param hostname (path) - Hostname (trailing dot optional)
2987
+ * @param hostname (path) - Hostname
2969
2988
  * @param auto_create_zone (query) - Auto create zone if it doesn't exist
2970
2989
  * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
2971
2990
  * @param wildcard (query) - Wildcard domain forwarding
@@ -2986,7 +3005,7 @@ export type PATCH_DomainForwardsByHostnameEnable_Response_401 = Problem
2986
3005
 
2987
3006
  *
2988
3007
  * @path /v1/domain-forwards/{hostname}/enable
2989
- * @param hostname (path) - Hostname (trailing dot optional)
3008
+ * @param hostname (path) - Hostname
2990
3009
  * @param auto_create_zone (query) - Auto create zone if it doesn't exist
2991
3010
  * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
2992
3011
  * @param wildcard (query) - Wildcard domain forwarding
@@ -3007,7 +3026,7 @@ export type PATCH_DomainForwardsByHostnameEnable_Response_403 = Problem
3007
3026
 
3008
3027
  *
3009
3028
  * @path /v1/domain-forwards/{hostname}/enable
3010
- * @param hostname (path) - Hostname (trailing dot optional)
3029
+ * @param hostname (path) - Hostname
3011
3030
  * @param auto_create_zone (query) - Auto create zone if it doesn't exist
3012
3031
  * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
3013
3032
  * @param wildcard (query) - Wildcard domain forwarding
package/src/openapi.yaml CHANGED
@@ -5290,10 +5290,35 @@ info:
5290
5290
 
5291
5291
 
5292
5292
 
5293
+ # Sandbox Environment
5294
+
5295
+
5296
+ We provide a free sandbox environment where you can test and make sure your integration
5297
+ with OpusDNS runs smoothly. The sandbox is completely isolated, meaning all domains,
5298
+ configurations, and actions inside this environment have no effect on your live
5299
+ data or production systems. It is a full test system for safe experimentation
5300
+ and completely free to use.
5301
+
5302
+
5303
+ Please register a new sandbox account at https://app.sandbox.opusdns.com and create
5304
+ a new API key there.
5305
+
5306
+
5307
+ This sandbox provides a separate dashboard at [app.sandbox.opusdns.com](https://app.sandbox.opusdns.com).
5308
+
5309
+
5310
+ The sandbox API Base URL is `https://sandbox.opusdns.com`.
5311
+
5312
+
5313
+ If you have any questions about the API or run into issues, please open a ticket
5314
+ at support@opusdns.com. We are happy to help!
5315
+
5316
+
5317
+
5293
5318
  '
5294
5319
  summary: OpusDNS - your gateway to a seamless domain management experience.
5295
5320
  title: OpusDNS API
5296
- version: 2025-11-14-091055
5321
+ version: 2025-11-17-131834
5297
5322
  x-logo:
5298
5323
  altText: OpusDNS API Reference
5299
5324
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -7181,12 +7206,12 @@ paths:
7181
7206
  description: Deletes the domain forward configuration for the specified hostname
7182
7207
  operationId: delete_domain_forward_v1_domain_forwards__hostname__delete
7183
7208
  parameters:
7184
- - description: Hostname (trailing dot optional)
7209
+ - description: Hostname
7185
7210
  in: path
7186
7211
  name: hostname
7187
7212
  required: true
7188
7213
  schema:
7189
- description: Hostname (trailing dot optional)
7214
+ description: Hostname
7190
7215
  title: Hostname
7191
7216
  type: string
7192
7217
  responses:
@@ -7243,12 +7268,12 @@ paths:
7243
7268
  description: Retrieves the domain forward configuration for the specified hostname
7244
7269
  operationId: get_domain_forward_v1_domain_forwards__hostname__get
7245
7270
  parameters:
7246
- - description: Hostname (trailing dot optional)
7271
+ - description: Hostname
7247
7272
  in: path
7248
7273
  name: hostname
7249
7274
  required: true
7250
7275
  schema:
7251
- description: Hostname (trailing dot optional)
7276
+ description: Hostname
7252
7277
  title: Hostname
7253
7278
  type: string
7254
7279
  responses:
@@ -7309,17 +7334,56 @@ paths:
7309
7334
  description: Creates a new domain forward configuration for the specified hostname
7310
7335
  operationId: create_domain_forward_v1_domain_forwards__hostname__post
7311
7336
  parameters:
7312
- - description: Hostname (trailing dot optional)
7337
+ - description: Hostname
7313
7338
  in: path
7314
7339
  name: hostname
7315
7340
  required: true
7316
7341
  schema:
7317
- description: Hostname (trailing dot optional)
7342
+ description: Hostname
7318
7343
  title: Hostname
7319
7344
  type: string
7320
7345
  requestBody:
7321
7346
  content:
7322
7347
  application/json:
7348
+ examples:
7349
+ domain_forward:
7350
+ description: Create a HTTP domain forward with redirect from HTTP
7351
+ to HTTPS and HTTPS to auth.example.com
7352
+ summary: HTTP domain forward
7353
+ value:
7354
+ enabled: false
7355
+ http:
7356
+ redirects:
7357
+ - redirect_code: 301
7358
+ request_path: /
7359
+ target_hostname: example.com
7360
+ target_path: /
7361
+ target_protocol: https
7362
+ wildcard: false
7363
+ https:
7364
+ redirects:
7365
+ - redirect_code: 302
7366
+ request_path: /
7367
+ target_hostname: auth.example.com
7368
+ target_path: /
7369
+ target_protocol: https
7370
+ wildcard: false
7371
+ wildcard: false
7372
+ http_to_https:
7373
+ description: Create a HTTP domain forward with redirect from HTTP
7374
+ to HTTPS
7375
+ summary: HTTP to HTTPS
7376
+ value:
7377
+ enabled: false
7378
+ https:
7379
+ redirects:
7380
+ - redirect_code: 301
7381
+ request_path: /
7382
+ target_hostname: example.com
7383
+ target_path: /
7384
+ target_protocol: https
7385
+ wildcard: false
7386
+ wildcard: false
7323
7387
  schema:
7324
7388
  $ref: '#/components/schemas/DomainForwardRequest'
7325
7389
  required: true
@@ -7327,9 +7391,65 @@ paths:
7327
7391
  '201':
7328
7392
  content:
7329
7393
  application/json:
7394
+ examples:
7395
+ http_domain_forward_response:
7396
+ description: Response when creating a HTTP domain forward with redirect
7397
+ from HTTP to HTTPS and HTTPS to auth.example.com
7398
+ summary: Response for HTTP domain forward
7399
+ value:
7400
+ created_on: '2025-11-14T09:01:38'
7401
+ enabled: false
7402
+ hostname: example.com.
7403
+ http:
7404
+ created_on: '2025-11-14T09:01:38'
7405
+ redirects:
7406
+ - redirect_code: 301
7407
+ request_hostname: example.com.
7408
+ request_path: /
7409
+ request_protocol: http
7410
+ target_hostname: example.com
7411
+ target_path: /
7412
+ target_protocol: https
7413
+ updated_on: '2025-11-14T09:01:38'
7414
+ wildcard: false
7415
+ https:
7416
+ created_on: '2025-11-14T09:01:38'
7417
+ redirects:
7418
+ - redirect_code: 302
7419
+ request_hostname: example.com.
7420
+ request_path: /
7421
+ request_protocol: https
7422
+ target_hostname: auth.example.com
7423
+ target_path: /
7424
+ target_protocol: https
7425
+ updated_on: '2025-11-14T09:01:38'
7426
+ wildcard: false
7427
+ updated_on: '2025-11-14T09:01:38'
7428
+ wildcard: false
7429
+ http_to_https_response:
7430
+ description: Response when creating a HTTP to HTTPS domain forward
7431
+ summary: Response for HTTP to HTTPS
7432
+ value:
7433
+ created_on: '2025-11-14T09:01:38'
7434
+ enabled: false
7435
+ hostname: example.com.
7436
+ http:
7437
+ created_on: '2025-11-14T09:01:38'
7438
+ redirects:
7439
+ - redirect_code: 301
7440
+ request_hostname: example.com.
7441
+ request_path: /
7442
+ request_protocol: http
7443
+ target_hostname: example.com
7444
+ target_path: /
7445
+ target_protocol: https
7446
+ updated_on: '2025-11-14T09:01:38'
7447
+ wildcard: false
7448
+ updated_on: '2025-11-14T09:01:38'
7449
+ wildcard: false
7330
7450
  schema:
7331
7451
  $ref: '#/components/schemas/DomainForward'
7332
- description: Successful Response
7452
+ description: Domain forward created successfully
7333
7453
  '401':
7334
7454
  content:
7335
7455
  application/problem+json:
@@ -7354,18 +7474,31 @@ paths:
7354
7474
  schema:
7355
7475
  $ref: '#/components/schemas/Problem'
7356
7476
  description: Forbidden
7477
+ '404':
7478
+ content:
7479
+ application/problem+json:
7480
+ example:
7481
+ code: ERROR_ZONE_NOT_FOUND
7482
+ detail: Zone not found
7483
+ status: 404
7484
+ title: DNS Error
7485
+ type: dns-zone-not-found
7486
+ zone_name: Zone example.com. not found
7487
+ schema:
7488
+ $ref: '#/components/schemas/Problem'
7489
+ description: DNS zone was not found
7357
7490
  '409':
7358
7491
  content:
7359
7492
  application/problem+json:
7360
7493
  example:
7361
7494
  code: ERROR_DOMAIN_FORWARD_ALREADY_EXISTS
7362
- detail: Domain forward already exists for Additional error context.
7495
+ detail: Domain forward already exists for example.com.
7363
7496
  status: 409
7364
7497
  title: Domain Forward Error
7365
7498
  type: domain-forward-already-exists
7366
7499
  schema:
7367
7500
  $ref: '#/components/schemas/Problem'
7368
- description: Conflict
7501
+ description: Domain forward already exists
7369
7502
  '422':
7370
7503
  content:
7371
7504
  application/problem+json:
@@ -7383,12 +7516,12 @@ paths:
7383
7516
  forward configuration is preserved but disabled.
7384
7517
  operationId: disable_domain_forward_v1_domain_forwards__hostname__disable_patch
7385
7518
  parameters:
7386
- - description: Hostname (trailing dot optional)
7519
+ - description: Hostname
7387
7520
  in: path
7388
7521
  name: hostname
7389
7522
  required: true
7390
7523
  schema:
7391
- description: Hostname (trailing dot optional)
7524
+ description: Hostname
7392
7525
  title: Hostname
7393
7526
  type: string
7394
7527
  responses:
@@ -7435,12 +7568,12 @@ paths:
7435
7568
  auto-creates the zone and domain forward if they don't exist.
7436
7569
  operationId: enable_domain_forward_v1_domain_forwards__hostname__enable_patch
7437
7570
  parameters:
7438
- - description: Hostname (trailing dot optional)
7571
+ - description: Hostname
7439
7572
  in: path
7440
7573
  name: hostname
7441
7574
  required: true
7442
7575
  schema:
7443
- description: Hostname (trailing dot optional)
7576
+ description: Hostname
7444
7577
  title: Hostname
7445
7578
  type: string
7446
7579
  - description: Auto create zone if it doesn't exist
@@ -7530,12 +7663,12 @@ paths:
7530
7663
  required: true
7531
7664
  schema:
7532
7665
  $ref: '#/components/schemas/HttpProtocol'
7533
- - description: Hostname (trailing dot optional)
7666
+ - description: Hostname
7534
7667
  in: path
7535
7668
  name: hostname
7536
7669
  required: true
7537
7670
  schema:
7538
- description: Hostname (trailing dot optional)
7671
+ description: Hostname
7539
7672
  title: Hostname
7540
7673
  type: string
7541
7674
  responses:
@@ -7598,12 +7731,12 @@ paths:
7598
7731
  required: true
7599
7732
  schema:
7600
7733
  $ref: '#/components/schemas/HttpProtocol'
7601
- - description: Hostname (trailing dot optional)
7734
+ - description: Hostname
7602
7735
  in: path
7603
7736
  name: hostname
7604
7737
  required: true
7605
7738
  schema:
7606
- description: Hostname (trailing dot optional)
7739
+ description: Hostname
7607
7740
  title: Hostname
7608
7741
  type: string
7609
7742
  responses:
@@ -7670,12 +7803,12 @@ paths:
7670
7803
  required: true
7671
7804
  schema:
7672
7805
  $ref: '#/components/schemas/HttpProtocol'
7673
- - description: Hostname (trailing dot optional)
7806
+ - description: Hostname
7674
7807
  in: path
7675
7808
  name: hostname
7676
7809
  required: true
7677
7810
  schema:
7678
- description: Hostname (trailing dot optional)
7811
+ description: Hostname
7679
7812
  title: Hostname
7680
7813
  type: string
7681
7814
  requestBody:
@@ -7761,12 +7894,12 @@ paths:
7761
7894
  required: true
7762
7895
  schema:
7763
7896
  $ref: '#/components/schemas/HttpProtocol'
7764
- - description: Hostname (trailing dot optional)
7897
+ - description: Hostname
7765
7898
  in: path
7766
7899
  name: hostname
7767
7900
  required: true
7768
7901
  schema:
7769
- description: Hostname (trailing dot optional)
7902
+ description: Hostname
7770
7903
  title: Hostname
7771
7904
  type: string
7772
7905
  requestBody:
package/src/schema.d.ts CHANGED
@@ -6330,7 +6330,7 @@ export interface operations {
6330
6330
  query?: never;
6331
6331
  header?: never;
6332
6332
  path: {
6333
- /** @description Hostname (trailing dot optional) */
6333
+ /** @description Hostname */
6334
6334
  hostname: string;
6335
6335
  };
6336
6336
  cookie?: never;
@@ -6410,7 +6410,7 @@ export interface operations {
6410
6410
  query?: never;
6411
6411
  header?: never;
6412
6412
  path: {
6413
- /** @description Hostname (trailing dot optional) */
6413
+ /** @description Hostname */
6414
6414
  hostname: string;
6415
6415
  };
6416
6416
  cookie?: never;
@@ -6421,7 +6421,7 @@ export interface operations {
6421
6421
  };
6422
6422
  };
6423
6423
  responses: {
6424
- /** @description Successful Response */
6424
+ /** @description Domain forward created successfully */
6425
6425
  201: {
6426
6426
  headers: {
6427
6427
  [name: string]: unknown;
@@ -6462,7 +6462,24 @@ export interface operations {
6462
6462
  "application/problem+json": components["schemas"]["Problem"];
6463
6463
  };
6464
6464
  };
6465
- /** @description Conflict */
6465
+ /** @description DNS zone was not found */
6466
+ 404: {
6467
+ headers: {
6468
+ [name: string]: unknown;
6469
+ };
6470
+ content: {
6471
+ /** @example {
6472
+ * "code": "ERROR_ZONE_NOT_FOUND",
6473
+ * "detail": "Zone not found",
6474
+ * "status": 404,
6475
+ * "title": "DNS Error",
6476
+ * "type": "dns-zone-not-found",
6477
+ * "zone_name": "Zone example.com. not found"
6478
+ * } */
6479
+ "application/problem+json": components["schemas"]["Problem"];
6480
+ };
6481
+ };
6482
+ /** @description Domain forward already exists */
6466
6483
  409: {
6467
6484
  headers: {
6468
6485
  [name: string]: unknown;
@@ -6470,7 +6487,7 @@ export interface operations {
6470
6487
  content: {
6471
6488
  /** @example {
6472
6489
  * "code": "ERROR_DOMAIN_FORWARD_ALREADY_EXISTS",
6473
- * "detail": "Domain forward already exists for Additional error context.",
6490
+ * "detail": "Domain forward already exists for example.com.",
6474
6491
  * "status": 409,
6475
6492
  * "title": "Domain Forward Error",
6476
6493
  * "type": "domain-forward-already-exists"
@@ -6494,7 +6511,7 @@ export interface operations {
6494
6511
  query?: never;
6495
6512
  header?: never;
6496
6513
  path: {
6497
- /** @description Hostname (trailing dot optional) */
6514
+ /** @description Hostname */
6498
6515
  hostname: string;
6499
6516
  };
6500
6517
  cookie?: never;
@@ -6572,7 +6589,7 @@ export interface operations {
6572
6589
  query?: never;
6573
6590
  header?: never;
6574
6591
  path: {
6575
- /** @description Hostname (trailing dot optional) */
6592
+ /** @description Hostname */
6576
6593
  hostname: string;
6577
6594
  };
6578
6595
  cookie?: never;
@@ -6641,7 +6658,7 @@ export interface operations {
6641
6658
  };
6642
6659
  header?: never;
6643
6660
  path: {
6644
- /** @description Hostname (trailing dot optional) */
6661
+ /** @description Hostname */
6645
6662
  hostname: string;
6646
6663
  };
6647
6664
  cookie?: never;
@@ -6720,7 +6737,7 @@ export interface operations {
6720
6737
  header?: never;
6721
6738
  path: {
6722
6739
  protocol: components["schemas"]["HttpProtocol"];
6723
- /** @description Hostname (trailing dot optional) */
6740
+ /** @description Hostname */
6724
6741
  hostname: string;
6725
6742
  };
6726
6743
  cookie?: never;
@@ -6801,7 +6818,7 @@ export interface operations {
6801
6818
  header?: never;
6802
6819
  path: {
6803
6820
  protocol: components["schemas"]["HttpProtocol"];
6804
- /** @description Hostname (trailing dot optional) */
6821
+ /** @description Hostname */
6805
6822
  hostname: string;
6806
6823
  };
6807
6824
  cookie?: never;
@@ -6886,7 +6903,7 @@ export interface operations {
6886
6903
  header?: never;
6887
6904
  path: {
6888
6905
  protocol: components["schemas"]["HttpProtocol"];
6889
- /** @description Hostname (trailing dot optional) */
6906
+ /** @description Hostname */
6890
6907
  hostname: string;
6891
6908
  };
6892
6909
  cookie?: never;
@@ -6987,7 +7004,7 @@ export interface operations {
6987
7004
  header?: never;
6988
7005
  path: {
6989
7006
  protocol: components["schemas"]["HttpProtocol"];
6990
- /** @description Hostname (trailing dot optional) */
7007
+ /** @description Hostname */
6991
7008
  hostname: string;
6992
7009
  };
6993
7010
  cookie?: never;