File size: 19,521 Bytes
048b1e8 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 | components:
responses:
ErrorResponse:
description: api error response
content:
application/problem+json:
schema:
oneOf:
- $ref: '#/components/responses/BadRequest'
- $ref: '#/components/responses/Unauthorized'
- $ref: '#/components/responses/Forbidden'
- $ref: '#/components/responses/NotFound'
- $ref: '#/components/responses/Conflict'
- $ref: '#/components/responses/Gone'
- $ref: '#/components/responses/Internal'
- $ref: '#/components/responses/NotAvailable'
discriminator:
propertyName: status
mapping:
'400': '#/components/responses/BadRequest'
'401': '#/components/responses/Unauthorized'
'403': '#/components/responses/Forbidden'
'404': '#/components/responses/NotFound'
'409': '#/components/responses/Conflict'
'410': '#/components/responses/Gone'
'500': '#/components/responses/Internal'
'503': '#/components/responses/NotAvailable'
# 400
BadRequest:
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequestError'
KonnectCPLegacyBadRequest:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/KonnectCPLegacyBadRequestError'
examples:
UnauthorizedExample:
$ref: '#/components/examples/KonnectCPLegacyBadRequestExample'
# 401
Unauthorized:
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
examples:
UnauthorizedExample:
$ref: '#/components/examples/UnauthorizedExample'
KonnectCPLegacyUnauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/KonnectCPLegacyUnauthorizedError'
examples:
UnauthorizedExample:
$ref: '#/components/examples/KonnectCPLegacyUnauthorizedExample'
# 403
Forbidden:
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ForbiddenError'
examples:
UnauthorizedExample:
$ref: '#/components/examples/ForbiddenExample'
KonnectCPLegacyForbidden:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/KonnectCPLegacyForbiddenError'
examples:
UnauthorizedExample:
$ref: '#/components/examples/KonnectCPLegacyForbiddenExample'
# 404
NotFound:
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/NotFoundError'
examples:
NotFoundExample:
$ref: '#/components/examples/NotFoundExample'
KonnectCPLegacyNotFound:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/KonnectCPLegacyNotFoundError'
examples:
UnauthorizedExample:
$ref: '#/components/examples/KonnectCPLegacyNotFoundExample'
# 409
Conflict:
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConflictError'
KonnectCPLegacyConflict:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/KonnectCPLegacyConflictError'
examples:
UnauthorizedExample:
$ref: '#/components/examples/KonnectCPLegacyConflictExample'
# 410
Gone:
description: Gone
content:
application/problem+json:
schema:
$ref: '#/components/schemas/GoneError'
# 413
PayloadTooLarge:
description: Payload Too Large
content:
application/problem+json:
schema:
$ref: '#/components/schemas/PayloadTooLargeError'
# 415
UnsupportedMediaType:
description: Unsupported Media Type
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnsupportedMediaTypeError'
examples:
UnsupportedMediaTypeExample:
$ref: '#/components/examples/UnsupportedMediaTypeExample'
UnprocessableContent:
description: Unprocessable Content
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnprocessableContentError'
examples:
UnprocessableContentExample:
$ref: '#/components/examples/UnprocessableContentExample'
# 429
TooManyRequests:
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
# 500
Internal:
description: Internal
content:
application/problem+json:
schema:
$ref: '#/components/schemas/InternalError'
# 503
NotAvailable:
description: Service not available
content:
application/problem+json:
schema:
$ref: '#/components/schemas/NotAvailableError'
NotImplemented:
description: Not Implemented
content:
application/problem+json:
schema:
$ref: '#/components/schemas/NotImplementedError'
schemas:
InvalidRules:
description: invalid parameters rules
type: string
readOnly: true
nullable: true
enum:
- required
- is_array
- is_base64
- is_boolean
- is_date_time
- is_integer
- is_null
- is_number
- is_object
- is_string
- is_uuid
- is_fqdn
- is_arn
- unknown_property
- missing_reference
- is_label
- matches_regex
- invalid
- is_supported_network_availability_zone_list
- is_supported_network_cidr_block
- is_supported_provider_region
- type
InvalidParameters:
type: array
nullable: false
uniqueItems: true
minItems: 1
description: invalid parameters
items:
oneOf:
- $ref: '#/components/schemas/InvalidParameterStandard'
- $ref: '#/components/schemas/InvalidParameterMinimumLength'
- $ref: '#/components/schemas/InvalidParameterMaximumLength'
- $ref: '#/components/schemas/InvalidParameterChoiceItem'
- $ref: '#/components/schemas/InvalidParameterDependentItem'
InvalidParameterStandard:
type: object
additionalProperties: false
properties:
field:
type: string
example: name
readOnly: true
rule:
$ref: '#/components/schemas/InvalidRules'
source:
type: string
example: body
reason:
type: string
example: is a required field
readOnly: true
required:
- field
- reason
InvalidParameterMinimumLength:
type: object
additionalProperties: false
properties:
field:
type: string
example: name
readOnly: true
rule:
description: invalid parameters rules
type: string
readOnly: true
nullable: false
enum:
- min_length
- min_digits
- min_lowercase
- min_uppercase
- min_symbols
- min_items
- min
minimum:
type: integer
example: 8
source:
type: string
example: body
reason:
type: string
example: must have at least 8 characters
readOnly: true
required:
- field
- reason
- rule
- minimum
InvalidParameterMaximumLength:
type: object
additionalProperties: false
properties:
field:
type: string
example: name
readOnly: true
rule:
description: invalid parameters rules
type: string
readOnly: true
nullable: false
enum:
- max_length
- max_items
- max
maximum:
type: integer
example: 8
source:
type: string
example: body
reason:
type: string
example: must not have more than 8 characters
readOnly: true
required:
- field
- reason
- rule
- maximum
InvalidParameterChoiceItem:
type: object
additionalProperties: false
properties:
field:
type: string
example: name
readOnly: true
rule:
description: invalid parameters rules
type: string
readOnly: true
nullable: false
enum:
- enum
reason:
type: string
example: is a required field
readOnly: true
choices:
type: array
uniqueItems: true
readOnly: true
nullable: false
minItems: 1
items: {}
source:
type: string
example: body
required:
- field
- reason
- rule
- choices
InvalidParameterDependentItem:
type: object
additionalProperties: false
properties:
field:
type: string
example: name
readOnly: true
rule:
description: invalid parameters rules
type: string
readOnly: true
nullable: true
enum:
- dependent_fields
reason:
type: string
example: is a required field
readOnly: true
dependents:
type: array
uniqueItems: true
nullable: true
items: {}
readOnly: true
source:
type: string
example: body
required:
- field
- rule
- reason
- dependents
KonnectCPLegacyBaseError:
type: object
title: Error
description: standard error
properties:
message:
type: string
description: |
A short summary of the problem.
readOnly: true
BaseError:
type: object
title: Error
description: standard error
required:
- status
- title
- instance
- detail
properties:
status:
type: integer
description: |
The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.
readOnly: true
title:
type: string
description: |
A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as "Sentence case" for direct use in the UI.
readOnly: true
type:
type: string
description: The error type.
readOnly: true
instance:
type: string
description: |
Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.
readOnly: true
detail:
type: string
description: |
A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as "Sentence case" for direct use in the UI.
readOnly: true
BadRequestError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
required:
- invalid_parameters
properties:
invalid_parameters:
$ref: '#/components/schemas/InvalidParameters'
KonnectCPLegacyBadRequestError:
allOf:
- $ref: '#/components/schemas/KonnectCPLegacyBaseError'
- type: object
properties:
message:
example: Bad Request
UnauthorizedError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 401
title:
example: Unauthorized
type:
example: https://httpstatuses.com/401
instance:
example: kong:trace:1234567890
detail:
example: Invalid credentials
KonnectCPLegacyUnauthorizedError:
allOf:
- $ref: '#/components/schemas/KonnectCPLegacyBaseError'
- type: object
properties:
message:
example: Unauthorized
KonnectCPLegacyForbiddenError:
allOf:
- $ref: '#/components/schemas/KonnectCPLegacyBaseError'
- type: object
properties:
message:
example: Forbidden
KonnectCPLegacyNotFoundError:
allOf:
- $ref: '#/components/schemas/KonnectCPLegacyBaseError'
- type: object
properties:
message:
example: Not Found
ForbiddenError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 403
title:
example: Forbidden
type:
example: https://httpstatuses.com/403
instance:
example: kong:trace:1234567890
detail:
example: Forbidden
NotFoundError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 404
title:
example: Not Found
type:
example: https://httpstatuses.com/404
instance:
example: kong:trace:1234567890
detail:
example: Not found
NotImplementedError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 501
title:
example: Not Implemented
type:
example: https://httpstatuses.com/501
instance:
example: kong:trace:1234567890
detail:
example: Not Implemented
ConflictError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 409
title:
example: Conflict
type:
example: https://httpstatuses.com/409
instance:
example: kong:trace:1234567890
detail:
example: Conflict
KonnectCPLegacyConflictError:
allOf:
- $ref: '#/components/schemas/KonnectCPLegacyBaseError'
- type: object
properties:
message:
example: Conflict
PayloadTooLargeError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 413
title:
example: Payload Too Large
type:
example: https://httpstatuses.com/413
instance:
example: kong:trace:1234567890
detail:
example: Payload Too Large
UnsupportedMediaTypeError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 415
title:
example: UnsupportedMediaType
type:
example: https://httpstatuses.com/415
instance:
example: kong:trace:1234567890
detail:
example: UnsupportedMediaType
UnprocessableContentError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 422
title:
example: Unprocessable Content
type:
example: https://httpstatuses.com/422
instance:
example: kong:trace:1234567891
detail:
example: Unprocessable Content
TooManyRequestsError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 429
title:
example: Too Many Requests
type:
example: https://httpstatuses.com/429
instance:
example: kong:trace:1234567890
detail:
example: Too Many Requests
GoneError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 410
title:
example: Gone
type:
example: https://httpstatuses.com/410
instance:
example: kong:trace:1234567890
detail:
example: Gone
InternalError:
$ref: '#/components/schemas/BaseError'
NotAvailableError:
$ref: '#/components/schemas/BaseError'
examples:
ForbiddenExample:
value:
status: 403
title: Forbidden
instance: kong:trace:2723154947768991354
detail: You do not have permission to perform this action
KonnectCPLegacyBadRequestExample:
value:
message: Bad Request
KonnectCPLegacyUnauthorizedExample:
value:
message: Unauthorized
KonnectCPLegacyForbiddenExample:
value:
message: Forbidden
KonnectCPLegacyNotFoundExample:
value:
message: Not Found
KonnectCPLegacyConflictExample:
value:
message: Conflict
NotFoundExample:
value:
status: 404
title: Not Found
instance: kong:trace:6816496025408232265
detail: Not Found
UnsupportedMediaTypeExample:
value:
status: 415
title: Unsupported Media Type
instance: kong:trace:8347343766220159418
detail: 'This API only supports requests with `Content-Type: application/json`'
UnprocessableContentExample:
value:
status: 422
title: Unprocessable Content
instance: kong:trace:8347343766220159419
detail: 'The requested operation cannot be performed with the provided data'
UnauthorizedExample:
value:
status: 401
title: Unauthorized
instance: kong:trace:8347343766220159418
detail: Unauthorized
|