|
| 1 | +--- |
| 2 | +components: |
| 3 | + fields: |
| 4 | + instance: |
| 5 | + type: string |
| 6 | + example: 797a8f199c45014ab7b08bfe9cc1c12c |
| 7 | + responses: |
| 8 | + DefaultError: |
| 9 | + description: Default Error |
| 10 | + content: |
| 11 | + application/json: |
| 12 | + schema: |
| 13 | + properties: |
| 14 | + type: |
| 15 | + type: string |
| 16 | + example: 'https://developer.nexmo.com/api-errors#TO_BE_UPDATED' |
| 17 | + title: |
| 18 | + type: string |
| 19 | + example: THIS ERROR NEEDS REPLACING |
| 20 | + detail: |
| 21 | + type: string |
| 22 | + example: THIS IS A PLACEHOLDER FOR OTHER ERRORS |
| 23 | + instance: |
| 24 | + $ref: '#/components/fields/instance' |
| 25 | + BadCredentialsError: |
| 26 | + description: Credential is missing or invalid |
| 27 | + content: |
| 28 | + application/json: |
| 29 | + schema: |
| 30 | + properties: |
| 31 | + type: |
| 32 | + type: string |
| 33 | + example: 'https://developer.nexmo.com/api-errors#unauthorized' |
| 34 | + title: |
| 35 | + type: string |
| 36 | + example: Invalid credentials supplied |
| 37 | + detail: |
| 38 | + type: string |
| 39 | + example: You did not provide correct credentials. |
| 40 | + instance: |
| 41 | + $ref: '#/components/fields/instance' |
| 42 | + NotFoundError: |
| 43 | + description: Resource Not Found |
| 44 | + content: |
| 45 | + application/json: |
| 46 | + schema: |
| 47 | + properties: |
| 48 | + type: |
| 49 | + type: string |
| 50 | + example: 'https://developer.nexmo.com/api-errors#not-found' |
| 51 | + title: |
| 52 | + type: string |
| 53 | + example: Not Found |
| 54 | + detail: |
| 55 | + type: string |
| 56 | + example: ID 'ABC123' does not exist, or you do not have access |
| 57 | + instance: |
| 58 | + $ref: '#/components/fields/instance' |
| 59 | + InvalidRequestMethod: |
| 60 | + description: Invalid Request Method |
| 61 | + content: |
| 62 | + application/json: |
| 63 | + schema: |
| 64 | + properties: |
| 65 | + type: |
| 66 | + type: string |
| 67 | + example: 'https://developer.nexmo.com/api-errors#wrong-verb' |
| 68 | + title: |
| 69 | + type: string |
| 70 | + example: Request method not allowed |
| 71 | + detail: |
| 72 | + type: string |
| 73 | + example: Request method 'TRACE' not supported |
| 74 | + instance: |
| 75 | + $ref: '#/components/fields/instance' |
| 76 | + InvalidAcceptHeader: |
| 77 | + description: Invalid Accept Header |
| 78 | + content: |
| 79 | + application/json: |
| 80 | + schema: |
| 81 | + properties: |
| 82 | + type: |
| 83 | + type: string |
| 84 | + example: 'https://developer.nexmo.com/api-errors#accept-header' |
| 85 | + title: |
| 86 | + type: string |
| 87 | + example: Invalid Accept header |
| 88 | + detail: |
| 89 | + type: string |
| 90 | + example: "Invalid Accept header provided. Must be one of the following: 'application/json'" |
| 91 | + instance: |
| 92 | + $ref: '#/components/fields/instance' |
| 93 | + UnsupportedContentTypeHeader: |
| 94 | + description: Unsupported Content Type Header |
| 95 | + content: |
| 96 | + application/json: |
| 97 | + schema: |
| 98 | + properties: |
| 99 | + type: |
| 100 | + type: string |
| 101 | + example: 'https://developer.nexmo.com/api-errors#content-type-header' |
| 102 | + title: |
| 103 | + type: string |
| 104 | + example: Unsupported Content-Type header |
| 105 | + detail: |
| 106 | + type: string |
| 107 | + example: "Unsupported Content-Type header provided. Must be one of the following: 'application/json'" |
| 108 | + instance: |
| 109 | + $ref: '#/components/fields/instance' |
0 commit comments