@opusdns/api 0.81.0 → 0.83.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/src/openapi.yaml CHANGED
@@ -3498,6 +3498,20 @@ components:
3498
3498
  - pagination
3499
3499
  title: Pagination[Organization]
3500
3500
  type: object
3501
+ Pagination_Redirect_:
3502
+ properties:
3503
+ pagination:
3504
+ $ref: '#/components/schemas/PaginationMetadata'
3505
+ results:
3506
+ items:
3507
+ $ref: '#/components/schemas/Redirect'
3508
+ title: Results
3509
+ type: array
3510
+ required:
3511
+ - results
3512
+ - pagination
3513
+ title: Pagination[Redirect]
3514
+ type: object
3501
3515
  Pagination_User_:
3502
3516
  properties:
3503
3517
  pagination:
@@ -3761,6 +3775,141 @@ components:
3761
3775
  title: Rdap Server
3762
3776
  title: RdapBase
3763
3777
  type: object
3778
+ Redirect:
3779
+ properties:
3780
+ redirect_code:
3781
+ title: Redirect Code
3782
+ type: integer
3783
+ request_domain:
3784
+ title: Request Domain
3785
+ type: string
3786
+ request_path:
3787
+ title: Request Path
3788
+ type: string
3789
+ request_protocol:
3790
+ title: Request Protocol
3791
+ type: string
3792
+ request_subdomain:
3793
+ title: Request Subdomain
3794
+ type: string
3795
+ target_domain:
3796
+ title: Target Domain
3797
+ type: string
3798
+ target_path:
3799
+ title: Target Path
3800
+ type: string
3801
+ target_protocol:
3802
+ title: Target Protocol
3803
+ type: string
3804
+ target_subdomain:
3805
+ title: Target Subdomain
3806
+ type: string
3807
+ required:
3808
+ - request_protocol
3809
+ - request_subdomain
3810
+ - request_path
3811
+ - target_protocol
3812
+ - target_subdomain
3813
+ - target_domain
3814
+ - target_path
3815
+ - redirect_code
3816
+ - request_domain
3817
+ title: Redirect
3818
+ type: object
3819
+ RedirectPatchOp:
3820
+ properties:
3821
+ op:
3822
+ $ref: '#/components/schemas/PatchOp'
3823
+ redirect:
3824
+ anyOf:
3825
+ - $ref: '#/components/schemas/Redirect'
3826
+ - $ref: '#/components/schemas/RedirectRemove'
3827
+ title: Redirect
3828
+ required:
3829
+ - op
3830
+ - redirect
3831
+ title: RedirectPatchOp
3832
+ type: object
3833
+ RedirectPatchOps:
3834
+ properties:
3835
+ ops:
3836
+ items:
3837
+ $ref: '#/components/schemas/RedirectPatchOp'
3838
+ title: Ops
3839
+ type: array
3840
+ required:
3841
+ - ops
3842
+ title: RedirectPatchOps
3843
+ type: object
3844
+ RedirectRemove:
3845
+ properties:
3846
+ request_domain:
3847
+ title: Request Domain
3848
+ type: string
3849
+ request_path:
3850
+ title: Request Path
3851
+ type: string
3852
+ request_protocol:
3853
+ title: Request Protocol
3854
+ type: string
3855
+ request_subdomain:
3856
+ title: Request Subdomain
3857
+ type: string
3858
+ required:
3859
+ - request_protocol
3860
+ - request_subdomain
3861
+ - request_path
3862
+ - request_domain
3863
+ title: RedirectRemove
3864
+ type: object
3865
+ RedirectSet:
3866
+ properties:
3867
+ redirects:
3868
+ items:
3869
+ $ref: '#/components/schemas/RedirectUpdate'
3870
+ title: Redirects
3871
+ type: array
3872
+ required:
3873
+ - redirects
3874
+ title: RedirectSet
3875
+ type: object
3876
+ RedirectUpdate:
3877
+ properties:
3878
+ redirect_code:
3879
+ title: Redirect Code
3880
+ type: integer
3881
+ request_path:
3882
+ title: Request Path
3883
+ type: string
3884
+ request_protocol:
3885
+ title: Request Protocol
3886
+ type: string
3887
+ request_subdomain:
3888
+ title: Request Subdomain
3889
+ type: string
3890
+ target_domain:
3891
+ title: Target Domain
3892
+ type: string
3893
+ target_path:
3894
+ title: Target Path
3895
+ type: string
3896
+ target_protocol:
3897
+ title: Target Protocol
3898
+ type: string
3899
+ target_subdomain:
3900
+ title: Target Subdomain
3901
+ type: string
3902
+ required:
3903
+ - request_protocol
3904
+ - request_subdomain
3905
+ - request_path
3906
+ - target_protocol
3907
+ - target_subdomain
3908
+ - target_domain
3909
+ - target_path
3910
+ - redirect_code
3911
+ title: RedirectUpdate
3912
+ type: object
3764
3913
  RegistrantChangeType:
3765
3914
  enum:
3766
3915
  - update
@@ -4797,7 +4946,7 @@ info:
4797
4946
  '
4798
4947
  summary: OpusDNS - your gateway to a seamless domain management experience.
4799
4948
  title: OpusDNS API
4800
- version: 2025-10-06-172245
4949
+ version: 2025-10-14-131453
4801
4950
  x-logo:
4802
4951
  altText: OpusDNS API Reference
4803
4952
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -6096,112 +6245,347 @@ paths:
6096
6245
  summary: Update Zone Rrsets
6097
6246
  tags:
6098
6247
  - dns
6099
- /v1/domain-search/suggest:
6100
- get:
6101
- description: Get a list of domain suggestions based on a search query
6102
- operationId: suggest_v1_domain_search_suggest_get
6248
+ /v1/domain-forwards:
6249
+ patch:
6250
+ operationId: patch_redirects_v1_domain_forwards_patch
6251
+ requestBody:
6252
+ content:
6253
+ application/json:
6254
+ schema:
6255
+ $ref: '#/components/schemas/RedirectPatchOps'
6256
+ required: true
6257
+ responses:
6258
+ '204':
6259
+ description: Successful Response
6260
+ '422':
6261
+ content:
6262
+ application/problem+json:
6263
+ schema:
6264
+ $ref: '#/components/schemas/HTTPValidationError'
6265
+ description: Validation Error
6266
+ security:
6267
+ - OAuth2PasswordBearer: []
6268
+ summary: Patch Redirects
6269
+ tags:
6270
+ - domain_forward
6271
+ /v1/domain-forwards/{zone_name}:
6272
+ delete:
6273
+ operationId: delete_redirects_v1_domain_forwards__zone_name__delete
6103
6274
  parameters:
6104
- - description: The primary keyword or phrase for the domain search
6105
- in: query
6106
- name: query
6275
+ - description: DNS zone name (trailing dot optional)
6276
+ in: path
6277
+ name: zone_name
6107
6278
  required: true
6108
6279
  schema:
6109
- description: The primary keyword or phrase for the domain search
6110
- title: Query
6280
+ description: DNS zone name (trailing dot optional)
6281
+ title: Zone Name
6111
6282
  type: string
6112
- - description: The TLDs to include in the search
6113
- examples:
6114
- list:
6115
- summary: A list of TLDs
6116
- value:
6117
- - com
6118
- - net
6119
- in: query
6120
- name: tlds
6121
- required: false
6283
+ responses:
6284
+ '204':
6285
+ description: Successful Response
6286
+ '422':
6287
+ content:
6288
+ application/problem+json:
6289
+ schema:
6290
+ $ref: '#/components/schemas/HTTPValidationError'
6291
+ description: Validation Error
6292
+ security:
6293
+ - OAuth2PasswordBearer: []
6294
+ summary: Delete Redirects
6295
+ tags:
6296
+ - domain_forward
6297
+ get:
6298
+ operationId: get_redirects_v1_domain_forwards__zone_name__get
6299
+ parameters:
6300
+ - description: DNS zone name (trailing dot optional)
6301
+ in: path
6302
+ name: zone_name
6303
+ required: true
6122
6304
  schema:
6123
- anyOf:
6124
- - items:
6125
- pattern: ^[a-zA-Z]+$
6126
- type: string
6127
- type: array
6128
- - type: 'null'
6129
- description: The TLDs to include in the search
6130
- title: Tlds
6131
- - description: The maximum number of domain suggestions to return
6132
- in: query
6133
- name: limit
6305
+ description: DNS zone name (trailing dot optional)
6306
+ title: Zone Name
6307
+ type: string
6308
+ - in: query
6309
+ name: page
6134
6310
  required: false
6135
6311
  schema:
6136
- anyOf:
6137
- - maximum: 100
6138
- minimum: 1
6139
- type: integer
6140
- - type: 'null'
6141
- description: The maximum number of domain suggestions to return
6142
- title: Limit
6143
- - description: Whether to include premium domains in the suggestions
6144
- in: query
6145
- name: premium
6312
+ default: 1
6313
+ minimum: 1
6314
+ title: Page
6315
+ type: integer
6316
+ - in: query
6317
+ name: page_size
6146
6318
  required: false
6147
6319
  schema:
6148
- anyOf:
6149
- - type: boolean
6150
- - type: 'null'
6151
- description: Whether to include premium domains in the suggestions
6152
- title: Premium
6320
+ default: 10
6321
+ maximum: 100
6322
+ minimum: 1
6323
+ title: Page Size
6324
+ type: integer
6153
6325
  responses:
6154
6326
  '200':
6155
6327
  content:
6156
6328
  application/json:
6157
6329
  schema:
6158
- $ref: '#/components/schemas/DomainSearchResponse'
6330
+ $ref: '#/components/schemas/Pagination_Redirect_'
6159
6331
  description: Successful Response
6160
- '401':
6332
+ '422':
6333
+ content:
6334
+ application/problem+json:
6335
+ schema:
6336
+ $ref: '#/components/schemas/HTTPValidationError'
6337
+ description: Validation Error
6338
+ security:
6339
+ - OAuth2PasswordBearer: []
6340
+ summary: Get Redirects
6341
+ tags:
6342
+ - domain_forward
6343
+ post:
6344
+ operationId: create_redirects_v1_domain_forwards__zone_name__post
6345
+ parameters:
6346
+ - description: DNS zone name (trailing dot optional)
6347
+ in: path
6348
+ name: zone_name
6349
+ required: true
6350
+ schema:
6351
+ description: DNS zone name (trailing dot optional)
6352
+ title: Zone Name
6353
+ type: string
6354
+ requestBody:
6355
+ content:
6356
+ application/json:
6357
+ schema:
6358
+ $ref: '#/components/schemas/RedirectSet'
6359
+ required: true
6360
+ responses:
6361
+ '201':
6362
+ description: Successful Response
6363
+ '409':
6161
6364
  content:
6162
6365
  application/problem+json:
6163
6366
  example:
6164
- code: ERROR_AUTHENTICATION
6165
- detail: Additional error context.
6166
- status: 401
6167
- title: Authentication Error
6168
- type: authentication
6367
+ code: ERROR_DOMAIN_FORWARD_REDIRECT_ALREADY_EXISTS
6368
+ detail: Redirect already exists for A, d, d, i, t, i, o, n, a, l, ,
6369
+ e, r, r, o, r, , c, o, n, t, e, x, t, .
6370
+ status: 409
6371
+ title: Domain Forward Error
6372
+ type: domain-forward-redirect-already-exists
6169
6373
  schema:
6170
6374
  $ref: '#/components/schemas/Problem'
6171
- description: Unauthorized
6375
+ description: Conflict
6172
6376
  '422':
6173
6377
  content:
6174
6378
  application/problem+json:
6175
6379
  schema:
6176
6380
  $ref: '#/components/schemas/HTTPValidationError'
6177
6381
  description: Validation Error
6178
- '502':
6382
+ security:
6383
+ - OAuth2PasswordBearer: []
6384
+ summary: Create Redirects
6385
+ tags:
6386
+ - domain_forward
6387
+ put:
6388
+ operationId: update_redirects_v1_domain_forwards__zone_name__put
6389
+ parameters:
6390
+ - description: DNS zone name (trailing dot optional)
6391
+ in: path
6392
+ name: zone_name
6393
+ required: true
6394
+ schema:
6395
+ description: DNS zone name (trailing dot optional)
6396
+ title: Zone Name
6397
+ type: string
6398
+ requestBody:
6399
+ content:
6400
+ application/json:
6401
+ schema:
6402
+ $ref: '#/components/schemas/RedirectSet'
6403
+ required: true
6404
+ responses:
6405
+ '204':
6406
+ description: Successful Response
6407
+ '409':
6179
6408
  content:
6180
6409
  application/problem+json:
6181
6410
  example:
6182
- code: ERROR_DOMAIN_SEARCH_PROVIDER
6183
- detail: Additional error context.
6184
- status: 502
6185
- title: Domain Search Error
6186
- type: domain-search-provider
6411
+ code: ERROR_DOMAIN_FORWARD_REDIRECT_NOT_EXISTS
6412
+ detail: Redirect does not exist for A, d, d, i, t, i, o, n, a, l, ,
6413
+ e, r, r, o, r, , c, o, n, t, e, x, t, .
6414
+ status: 409
6415
+ title: Domain Forward Error
6416
+ type: domain-forward-redirect-not-exists
6187
6417
  schema:
6188
6418
  $ref: '#/components/schemas/Problem'
6189
- description: Bad Gateway
6419
+ description: Conflict
6420
+ '422':
6421
+ content:
6422
+ application/problem+json:
6423
+ schema:
6424
+ $ref: '#/components/schemas/HTTPValidationError'
6425
+ description: Validation Error
6190
6426
  security:
6191
6427
  - OAuth2PasswordBearer: []
6192
- summary: Suggest domains
6428
+ summary: Update Redirects
6193
6429
  tags:
6194
- - domain_search
6195
- /v1/domains:
6196
- get:
6197
- description: Retrieves a paginated list of all active domains
6198
- operationId: get_domains_v1_domains_get
6430
+ - domain_forward
6431
+ /v1/domain-forwards/{zone_name}/disable:
6432
+ patch:
6433
+ operationId: disable_domain_forward_v1_domain_forwards__zone_name__disable_patch
6199
6434
  parameters:
6200
- - in: query
6201
- name: sort_by
6202
- required: false
6203
- schema:
6204
- $ref: '#/components/schemas/DomainSortField'
6435
+ - description: DNS zone name (trailing dot optional)
6436
+ in: path
6437
+ name: zone_name
6438
+ required: true
6439
+ schema:
6440
+ description: DNS zone name (trailing dot optional)
6441
+ title: Zone Name
6442
+ type: string
6443
+ responses:
6444
+ '204':
6445
+ description: Successful Response
6446
+ '422':
6447
+ content:
6448
+ application/problem+json:
6449
+ schema:
6450
+ $ref: '#/components/schemas/HTTPValidationError'
6451
+ description: Validation Error
6452
+ security:
6453
+ - OAuth2PasswordBearer: []
6454
+ summary: Disable Domain Forward
6455
+ tags:
6456
+ - domain_forward
6457
+ /v1/domain-forwards/{zone_name}/enable:
6458
+ patch:
6459
+ operationId: enable_domain_forward_v1_domain_forwards__zone_name__enable_patch
6460
+ parameters:
6461
+ - description: DNS zone name (trailing dot optional)
6462
+ in: path
6463
+ name: zone_name
6464
+ required: true
6465
+ schema:
6466
+ description: DNS zone name (trailing dot optional)
6467
+ title: Zone Name
6468
+ type: string
6469
+ responses:
6470
+ '204':
6471
+ description: Successful Response
6472
+ '422':
6473
+ content:
6474
+ application/problem+json:
6475
+ schema:
6476
+ $ref: '#/components/schemas/HTTPValidationError'
6477
+ description: Validation Error
6478
+ security:
6479
+ - OAuth2PasswordBearer: []
6480
+ summary: Enable Domain Forward
6481
+ tags:
6482
+ - domain_forward
6483
+ /v1/domain-search/suggest:
6484
+ get:
6485
+ description: Get a list of domain suggestions based on a search query
6486
+ operationId: suggest_v1_domain_search_suggest_get
6487
+ parameters:
6488
+ - description: The primary keyword or phrase for the domain search
6489
+ in: query
6490
+ name: query
6491
+ required: true
6492
+ schema:
6493
+ description: The primary keyword or phrase for the domain search
6494
+ title: Query
6495
+ type: string
6496
+ - description: The TLDs to include in the search
6497
+ examples:
6498
+ list:
6499
+ summary: A list of TLDs
6500
+ value:
6501
+ - com
6502
+ - net
6503
+ in: query
6504
+ name: tlds
6505
+ required: false
6506
+ schema:
6507
+ anyOf:
6508
+ - items:
6509
+ pattern: ^[a-zA-Z]+$
6510
+ type: string
6511
+ type: array
6512
+ - type: 'null'
6513
+ description: The TLDs to include in the search
6514
+ title: Tlds
6515
+ - description: The maximum number of domain suggestions to return
6516
+ in: query
6517
+ name: limit
6518
+ required: false
6519
+ schema:
6520
+ anyOf:
6521
+ - maximum: 100
6522
+ minimum: 1
6523
+ type: integer
6524
+ - type: 'null'
6525
+ description: The maximum number of domain suggestions to return
6526
+ title: Limit
6527
+ - description: Whether to include premium domains in the suggestions
6528
+ in: query
6529
+ name: premium
6530
+ required: false
6531
+ schema:
6532
+ anyOf:
6533
+ - type: boolean
6534
+ - type: 'null'
6535
+ description: Whether to include premium domains in the suggestions
6536
+ title: Premium
6537
+ responses:
6538
+ '200':
6539
+ content:
6540
+ application/json:
6541
+ schema:
6542
+ $ref: '#/components/schemas/DomainSearchResponse'
6543
+ description: Successful Response
6544
+ '401':
6545
+ content:
6546
+ application/problem+json:
6547
+ example:
6548
+ code: ERROR_AUTHENTICATION
6549
+ detail: Additional error context.
6550
+ status: 401
6551
+ title: Authentication Error
6552
+ type: authentication
6553
+ schema:
6554
+ $ref: '#/components/schemas/Problem'
6555
+ description: Unauthorized
6556
+ '422':
6557
+ content:
6558
+ application/problem+json:
6559
+ schema:
6560
+ $ref: '#/components/schemas/HTTPValidationError'
6561
+ description: Validation Error
6562
+ '502':
6563
+ content:
6564
+ application/problem+json:
6565
+ example:
6566
+ code: ERROR_DOMAIN_SEARCH_PROVIDER
6567
+ detail: Additional error context.
6568
+ status: 502
6569
+ title: Domain Search Error
6570
+ type: domain-search-provider
6571
+ schema:
6572
+ $ref: '#/components/schemas/Problem'
6573
+ description: Bad Gateway
6574
+ security:
6575
+ - OAuth2PasswordBearer: []
6576
+ summary: Suggest domains
6577
+ tags:
6578
+ - domain_search
6579
+ /v1/domains:
6580
+ get:
6581
+ description: Retrieves a paginated list of all active domains
6582
+ operationId: get_domains_v1_domains_get
6583
+ parameters:
6584
+ - in: query
6585
+ name: sort_by
6586
+ required: false
6587
+ schema:
6588
+ $ref: '#/components/schemas/DomainSortField'
6205
6589
  default: created_on
6206
6590
  - in: query
6207
6591
  name: sort_order
@@ -7648,6 +8032,30 @@ paths:
7648
8032
  schema:
7649
8033
  $ref: '#/components/schemas/Pagination_Organization_'
7650
8034
  description: Successful Response
8035
+ '401':
8036
+ content:
8037
+ application/problem+json:
8038
+ example:
8039
+ code: ERROR_AUTHENTICATION
8040
+ detail: Additional error context.
8041
+ status: 401
8042
+ title: Authentication Error
8043
+ type: authentication
8044
+ schema:
8045
+ $ref: '#/components/schemas/Problem'
8046
+ description: Unauthorized
8047
+ '403':
8048
+ content:
8049
+ application/problem+json:
8050
+ example:
8051
+ code: ERROR_PERMISSION_DENIED
8052
+ detail: Insufficient permissions to perform this action
8053
+ status: 403
8054
+ title: Permission Denied
8055
+ type: permission-denied
8056
+ schema:
8057
+ $ref: '#/components/schemas/Problem'
8058
+ description: Forbidden
7651
8059
  '422':
7652
8060
  content:
7653
8061
  application/problem+json:
@@ -7675,6 +8083,30 @@ paths:
7675
8083
  schema:
7676
8084
  $ref: '#/components/schemas/Organization'
7677
8085
  description: Successful Response
8086
+ '401':
8087
+ content:
8088
+ application/problem+json:
8089
+ example:
8090
+ code: ERROR_AUTHENTICATION
8091
+ detail: Additional error context.
8092
+ status: 401
8093
+ title: Authentication Error
8094
+ type: authentication
8095
+ schema:
8096
+ $ref: '#/components/schemas/Problem'
8097
+ description: Unauthorized
8098
+ '403':
8099
+ content:
8100
+ application/problem+json:
8101
+ example:
8102
+ code: ERROR_PERMISSION_DENIED
8103
+ detail: Insufficient permissions to perform this action
8104
+ status: 403
8105
+ title: Permission Denied
8106
+ type: permission-denied
8107
+ schema:
8108
+ $ref: '#/components/schemas/Problem'
8109
+ description: Forbidden
7678
8110
  '422':
7679
8111
  content:
7680
8112
  application/problem+json:
@@ -7726,6 +8158,30 @@ paths:
7726
8158
  title: Response Get Attributes V1 Organizations Attributes Get
7727
8159
  type: array
7728
8160
  description: Successful Response
8161
+ '401':
8162
+ content:
8163
+ application/problem+json:
8164
+ example:
8165
+ code: ERROR_AUTHENTICATION
8166
+ detail: Additional error context.
8167
+ status: 401
8168
+ title: Authentication Error
8169
+ type: authentication
8170
+ schema:
8171
+ $ref: '#/components/schemas/Problem'
8172
+ description: Unauthorized
8173
+ '403':
8174
+ content:
8175
+ application/problem+json:
8176
+ example:
8177
+ code: ERROR_PERMISSION_DENIED
8178
+ detail: Insufficient permissions to perform this action
8179
+ status: 403
8180
+ title: Permission Denied
8181
+ type: permission-denied
8182
+ schema:
8183
+ $ref: '#/components/schemas/Problem'
8184
+ description: Forbidden
7729
8185
  '422':
7730
8186
  content:
7731
8187
  application/problem+json:
@@ -7773,6 +8229,30 @@ paths:
7773
8229
  title: Response Update Attributes V1 Organizations Attributes Patch
7774
8230
  type: array
7775
8231
  description: Successful Response
8232
+ '401':
8233
+ content:
8234
+ application/problem+json:
8235
+ example:
8236
+ code: ERROR_AUTHENTICATION
8237
+ detail: Additional error context.
8238
+ status: 401
8239
+ title: Authentication Error
8240
+ type: authentication
8241
+ schema:
8242
+ $ref: '#/components/schemas/Problem'
8243
+ description: Unauthorized
8244
+ '403':
8245
+ content:
8246
+ application/problem+json:
8247
+ example:
8248
+ code: ERROR_PERMISSION_DENIED
8249
+ detail: Insufficient permissions to perform this action
8250
+ status: 403
8251
+ title: Permission Denied
8252
+ type: permission-denied
8253
+ schema:
8254
+ $ref: '#/components/schemas/Problem'
8255
+ description: Forbidden
7776
8256
  '422':
7777
8257
  content:
7778
8258
  application/problem+json:
@@ -7825,6 +8305,30 @@ paths:
7825
8305
  Id Get
7826
8306
  type: array
7827
8307
  description: Successful Response
8308
+ '401':
8309
+ content:
8310
+ application/problem+json:
8311
+ example:
8312
+ code: ERROR_AUTHENTICATION
8313
+ detail: Additional error context.
8314
+ status: 401
8315
+ title: Authentication Error
8316
+ type: authentication
8317
+ schema:
8318
+ $ref: '#/components/schemas/Problem'
8319
+ description: Unauthorized
8320
+ '403':
8321
+ content:
8322
+ application/problem+json:
8323
+ example:
8324
+ code: ERROR_PERMISSION_DENIED
8325
+ detail: Insufficient permissions to perform this action
8326
+ status: 403
8327
+ title: Permission Denied
8328
+ type: permission-denied
8329
+ schema:
8330
+ $ref: '#/components/schemas/Problem'
8331
+ description: Forbidden
7828
8332
  '422':
7829
8333
  content:
7830
8334
  application/problem+json:
@@ -7873,13 +8377,37 @@ paths:
7873
8377
  Id Patch
7874
8378
  type: array
7875
8379
  description: Successful Response
7876
- '422':
8380
+ '401':
7877
8381
  content:
7878
8382
  application/problem+json:
7879
- schema:
7880
- $ref: '#/components/schemas/HTTPValidationError'
7881
- description: Validation Error
7882
- security:
8383
+ example:
8384
+ code: ERROR_AUTHENTICATION
8385
+ detail: Additional error context.
8386
+ status: 401
8387
+ title: Authentication Error
8388
+ type: authentication
8389
+ schema:
8390
+ $ref: '#/components/schemas/Problem'
8391
+ description: Unauthorized
8392
+ '403':
8393
+ content:
8394
+ application/problem+json:
8395
+ example:
8396
+ code: ERROR_PERMISSION_DENIED
8397
+ detail: Insufficient permissions to perform this action
8398
+ status: 403
8399
+ title: Permission Denied
8400
+ type: permission-denied
8401
+ schema:
8402
+ $ref: '#/components/schemas/Problem'
8403
+ description: Forbidden
8404
+ '422':
8405
+ content:
8406
+ application/problem+json:
8407
+ schema:
8408
+ $ref: '#/components/schemas/HTTPValidationError'
8409
+ description: Validation Error
8410
+ security:
7883
8411
  - OAuth2PasswordBearer: []
7884
8412
  summary: Update organization attributes
7885
8413
  tags:
@@ -7905,6 +8433,30 @@ paths:
7905
8433
  Get
7906
8434
  type: array
7907
8435
  description: Successful Response
8436
+ '401':
8437
+ content:
8438
+ application/problem+json:
8439
+ example:
8440
+ code: ERROR_AUTHENTICATION
8441
+ detail: Additional error context.
8442
+ status: 401
8443
+ title: Authentication Error
8444
+ type: authentication
8445
+ schema:
8446
+ $ref: '#/components/schemas/Problem'
8447
+ description: Unauthorized
8448
+ '403':
8449
+ content:
8450
+ application/problem+json:
8451
+ example:
8452
+ code: ERROR_PERMISSION_DENIED
8453
+ detail: Insufficient permissions to perform this action
8454
+ status: 403
8455
+ title: Permission Denied
8456
+ type: permission-denied
8457
+ schema:
8458
+ $ref: '#/components/schemas/Problem'
8459
+ description: Forbidden
7908
8460
  security:
7909
8461
  - OAuth2PasswordBearer: []
7910
8462
  summary: List IP restrictions
@@ -7932,6 +8484,30 @@ paths:
7932
8484
  schema:
7933
8485
  $ref: '#/components/schemas/IpRestrictionResponse'
7934
8486
  description: Successful Response
8487
+ '401':
8488
+ content:
8489
+ application/problem+json:
8490
+ example:
8491
+ code: ERROR_AUTHENTICATION
8492
+ detail: Additional error context.
8493
+ status: 401
8494
+ title: Authentication Error
8495
+ type: authentication
8496
+ schema:
8497
+ $ref: '#/components/schemas/Problem'
8498
+ description: Unauthorized
8499
+ '403':
8500
+ content:
8501
+ application/problem+json:
8502
+ example:
8503
+ code: ERROR_PERMISSION_DENIED
8504
+ detail: Insufficient permissions to perform this action
8505
+ status: 403
8506
+ title: Permission Denied
8507
+ type: permission-denied
8508
+ schema:
8509
+ $ref: '#/components/schemas/Problem'
8510
+ description: Forbidden
7935
8511
  '422':
7936
8512
  content:
7937
8513
  application/problem+json:
@@ -7960,6 +8536,30 @@ paths:
7960
8536
  responses:
7961
8537
  '204':
7962
8538
  description: Successful Response
8539
+ '401':
8540
+ content:
8541
+ application/problem+json:
8542
+ example:
8543
+ code: ERROR_AUTHENTICATION
8544
+ detail: Additional error context.
8545
+ status: 401
8546
+ title: Authentication Error
8547
+ type: authentication
8548
+ schema:
8549
+ $ref: '#/components/schemas/Problem'
8550
+ description: Unauthorized
8551
+ '403':
8552
+ content:
8553
+ application/problem+json:
8554
+ example:
8555
+ code: ERROR_PERMISSION_DENIED
8556
+ detail: Insufficient permissions to perform this action
8557
+ status: 403
8558
+ title: Permission Denied
8559
+ type: permission-denied
8560
+ schema:
8561
+ $ref: '#/components/schemas/Problem'
8562
+ description: Forbidden
7963
8563
  '422':
7964
8564
  content:
7965
8565
  application/problem+json:
@@ -7995,6 +8595,30 @@ paths:
7995
8595
  schema:
7996
8596
  $ref: '#/components/schemas/IpRestrictionResponse'
7997
8597
  description: Successful Response
8598
+ '401':
8599
+ content:
8600
+ application/problem+json:
8601
+ example:
8602
+ code: ERROR_AUTHENTICATION
8603
+ detail: Additional error context.
8604
+ status: 401
8605
+ title: Authentication Error
8606
+ type: authentication
8607
+ schema:
8608
+ $ref: '#/components/schemas/Problem'
8609
+ description: Unauthorized
8610
+ '403':
8611
+ content:
8612
+ application/problem+json:
8613
+ example:
8614
+ code: ERROR_PERMISSION_DENIED
8615
+ detail: Insufficient permissions to perform this action
8616
+ status: 403
8617
+ title: Permission Denied
8618
+ type: permission-denied
8619
+ schema:
8620
+ $ref: '#/components/schemas/Problem'
8621
+ description: Forbidden
7998
8622
  '422':
7999
8623
  content:
8000
8624
  application/problem+json:
@@ -8035,6 +8659,30 @@ paths:
8035
8659
  schema:
8036
8660
  $ref: '#/components/schemas/IpRestrictionResponse'
8037
8661
  description: Successful Response
8662
+ '401':
8663
+ content:
8664
+ application/problem+json:
8665
+ example:
8666
+ code: ERROR_AUTHENTICATION
8667
+ detail: Additional error context.
8668
+ status: 401
8669
+ title: Authentication Error
8670
+ type: authentication
8671
+ schema:
8672
+ $ref: '#/components/schemas/Problem'
8673
+ description: Unauthorized
8674
+ '403':
8675
+ content:
8676
+ application/problem+json:
8677
+ example:
8678
+ code: ERROR_PERMISSION_DENIED
8679
+ detail: Insufficient permissions to perform this action
8680
+ status: 403
8681
+ title: Permission Denied
8682
+ type: permission-denied
8683
+ schema:
8684
+ $ref: '#/components/schemas/Problem'
8685
+ description: Forbidden
8038
8686
  '422':
8039
8687
  content:
8040
8688
  application/problem+json:
@@ -8056,6 +8704,30 @@ paths:
8056
8704
  application/json:
8057
8705
  schema: {}
8058
8706
  description: Successful Response
8707
+ '401':
8708
+ content:
8709
+ application/problem+json:
8710
+ example:
8711
+ code: ERROR_AUTHENTICATION
8712
+ detail: Additional error context.
8713
+ status: 401
8714
+ title: Authentication Error
8715
+ type: authentication
8716
+ schema:
8717
+ $ref: '#/components/schemas/Problem'
8718
+ description: Unauthorized
8719
+ '403':
8720
+ content:
8721
+ application/problem+json:
8722
+ example:
8723
+ code: ERROR_PERMISSION_DENIED
8724
+ detail: Insufficient permissions to perform this action
8725
+ status: 403
8726
+ title: Permission Denied
8727
+ type: permission-denied
8728
+ schema:
8729
+ $ref: '#/components/schemas/Problem'
8730
+ description: Forbidden
8059
8731
  security:
8060
8732
  - OAuth2PasswordBearer: []
8061
8733
  summary: List all roles
@@ -8090,6 +8762,30 @@ paths:
8090
8762
  schema:
8091
8763
  $ref: '#/components/schemas/Pagination_User_'
8092
8764
  description: Successful Response
8765
+ '401':
8766
+ content:
8767
+ application/problem+json:
8768
+ example:
8769
+ code: ERROR_AUTHENTICATION
8770
+ detail: Additional error context.
8771
+ status: 401
8772
+ title: Authentication Error
8773
+ type: authentication
8774
+ schema:
8775
+ $ref: '#/components/schemas/Problem'
8776
+ description: Unauthorized
8777
+ '403':
8778
+ content:
8779
+ application/problem+json:
8780
+ example:
8781
+ code: ERROR_PERMISSION_DENIED
8782
+ detail: Insufficient permissions to perform this action
8783
+ status: 403
8784
+ title: Permission Denied
8785
+ type: permission-denied
8786
+ schema:
8787
+ $ref: '#/components/schemas/Problem'
8788
+ description: Forbidden
8093
8789
  '422':
8094
8790
  content:
8095
8791
  application/problem+json:
@@ -8120,6 +8816,30 @@ paths:
8120
8816
  responses:
8121
8817
  '204':
8122
8818
  description: Successful Response
8819
+ '401':
8820
+ content:
8821
+ application/problem+json:
8822
+ example:
8823
+ code: ERROR_AUTHENTICATION
8824
+ detail: Additional error context.
8825
+ status: 401
8826
+ title: Authentication Error
8827
+ type: authentication
8828
+ schema:
8829
+ $ref: '#/components/schemas/Problem'
8830
+ description: Unauthorized
8831
+ '403':
8832
+ content:
8833
+ application/problem+json:
8834
+ example:
8835
+ code: ERROR_PERMISSION_DENIED
8836
+ detail: Insufficient permissions to perform this action
8837
+ status: 403
8838
+ title: Permission Denied
8839
+ type: permission-denied
8840
+ schema:
8841
+ $ref: '#/components/schemas/Problem'
8842
+ description: Forbidden
8123
8843
  '422':
8124
8844
  content:
8125
8845
  application/problem+json:
@@ -8153,6 +8873,30 @@ paths:
8153
8873
  schema:
8154
8874
  $ref: '#/components/schemas/OrganizationWithBillingData'
8155
8875
  description: Successful Response
8876
+ '401':
8877
+ content:
8878
+ application/problem+json:
8879
+ example:
8880
+ code: ERROR_AUTHENTICATION
8881
+ detail: Additional error context.
8882
+ status: 401
8883
+ title: Authentication Error
8884
+ type: authentication
8885
+ schema:
8886
+ $ref: '#/components/schemas/Problem'
8887
+ description: Unauthorized
8888
+ '403':
8889
+ content:
8890
+ application/problem+json:
8891
+ example:
8892
+ code: ERROR_PERMISSION_DENIED
8893
+ detail: Insufficient permissions to perform this action
8894
+ status: 403
8895
+ title: Permission Denied
8896
+ type: permission-denied
8897
+ schema:
8898
+ $ref: '#/components/schemas/Problem'
8899
+ description: Forbidden
8156
8900
  '422':
8157
8901
  content:
8158
8902
  application/problem+json:
@@ -8192,6 +8936,30 @@ paths:
8192
8936
  schema:
8193
8937
  $ref: '#/components/schemas/Organization'
8194
8938
  description: Successful Response
8939
+ '401':
8940
+ content:
8941
+ application/problem+json:
8942
+ example:
8943
+ code: ERROR_AUTHENTICATION
8944
+ detail: Additional error context.
8945
+ status: 401
8946
+ title: Authentication Error
8947
+ type: authentication
8948
+ schema:
8949
+ $ref: '#/components/schemas/Problem'
8950
+ description: Unauthorized
8951
+ '403':
8952
+ content:
8953
+ application/problem+json:
8954
+ example:
8955
+ code: ERROR_PERMISSION_DENIED
8956
+ detail: Insufficient permissions to perform this action
8957
+ status: 403
8958
+ title: Permission Denied
8959
+ type: permission-denied
8960
+ schema:
8961
+ $ref: '#/components/schemas/Problem'
8962
+ description: Forbidden
8195
8963
  '422':
8196
8964
  content:
8197
8965
  application/problem+json:
@@ -8248,6 +9016,30 @@ paths:
8248
9016
  schema:
8249
9017
  $ref: '#/components/schemas/GetPricesResponse'
8250
9018
  description: Successful Response
9019
+ '401':
9020
+ content:
9021
+ application/problem+json:
9022
+ example:
9023
+ code: ERROR_AUTHENTICATION
9024
+ detail: Additional error context.
9025
+ status: 401
9026
+ title: Authentication Error
9027
+ type: authentication
9028
+ schema:
9029
+ $ref: '#/components/schemas/Problem'
9030
+ description: Unauthorized
9031
+ '403':
9032
+ content:
9033
+ application/problem+json:
9034
+ example:
9035
+ code: ERROR_PERMISSION_DENIED
9036
+ detail: Insufficient permissions to perform this action
9037
+ status: 403
9038
+ title: Permission Denied
9039
+ type: permission-denied
9040
+ schema:
9041
+ $ref: '#/components/schemas/Problem'
9042
+ description: Forbidden
8251
9043
  '422':
8252
9044
  content:
8253
9045
  application/problem+json:
@@ -8380,6 +9172,30 @@ paths:
8380
9172
  schema:
8381
9173
  $ref: '#/components/schemas/Pagination_BillingTransactionResponse_'
8382
9174
  description: Successful Response
9175
+ '401':
9176
+ content:
9177
+ application/problem+json:
9178
+ example:
9179
+ code: ERROR_AUTHENTICATION
9180
+ detail: Additional error context.
9181
+ status: 401
9182
+ title: Authentication Error
9183
+ type: authentication
9184
+ schema:
9185
+ $ref: '#/components/schemas/Problem'
9186
+ description: Unauthorized
9187
+ '403':
9188
+ content:
9189
+ application/problem+json:
9190
+ example:
9191
+ code: ERROR_PERMISSION_DENIED
9192
+ detail: Insufficient permissions to perform this action
9193
+ status: 403
9194
+ title: Permission Denied
9195
+ type: permission-denied
9196
+ schema:
9197
+ $ref: '#/components/schemas/Problem'
9198
+ description: Forbidden
8383
9199
  '422':
8384
9200
  content:
8385
9201
  application/problem+json:
@@ -8425,6 +9241,30 @@ paths:
8425
9241
  schema:
8426
9242
  $ref: '#/components/schemas/BillingTransactionResponse'
8427
9243
  description: Successful Response
9244
+ '401':
9245
+ content:
9246
+ application/problem+json:
9247
+ example:
9248
+ code: ERROR_AUTHENTICATION
9249
+ detail: Additional error context.
9250
+ status: 401
9251
+ title: Authentication Error
9252
+ type: authentication
9253
+ schema:
9254
+ $ref: '#/components/schemas/Problem'
9255
+ description: Unauthorized
9256
+ '403':
9257
+ content:
9258
+ application/problem+json:
9259
+ example:
9260
+ code: ERROR_PERMISSION_DENIED
9261
+ detail: Insufficient permissions to perform this action
9262
+ status: 403
9263
+ title: Permission Denied
9264
+ type: permission-denied
9265
+ schema:
9266
+ $ref: '#/components/schemas/Problem'
9267
+ description: Forbidden
8428
9268
  '422':
8429
9269
  content:
8430
9270
  application/problem+json: