Add synthetics test result failure field

.apigentools-info

@@ -3,14 +3,14 @@
     "info_version": "2",
     "spec_versions": {
         "v1": {
-            "apigentools_version": "1.6.1",
-            "regenerated": "2022-01-31 10:15:52.528410",
-            "spec_repo_commit": "28778f1"
+            "apigentools_version": "1.6.2",
+            "regenerated": "2022-02-02 08:53:30.200759",
+            "spec_repo_commit": "d0d1224"
         },
         "v2": {
-            "apigentools_version": "1.6.1",
-            "regenerated": "2022-01-31 10:15:52.545103",
-            "spec_repo_commit": "28778f1"
+            "apigentools_version": "1.6.2",
+            "regenerated": "2022-02-02 08:53:30.219598",
+            "spec_repo_commit": "d0d1224"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -9897,13 +9897,10 @@ components:
       properties:
         cert:
           $ref: '#/components/schemas/SyntheticsSSLCertificate'
-        errorCode:
-          $ref: '#/components/schemas/SyntheticsErrorCode'
-        errorMessage:
-          description: The API test error message.
-          type: string
         eventType:
           $ref: '#/components/schemas/SyntheticsTestProcessStatus'
+        failure:
+          $ref: '#/components/schemas/SyntheticsApiTestResultFailure'
         httpStatusCode:
           description: The API test HTTP status code.
           format: int64
@@ -9994,6 +9991,73 @@ components:
       type: string
       x-enum-varnames:
       - API
+    SyntheticsApiTestFailureCode:
+      description: Error code that can be returned by a Synthetic test.
+      enum:
+      - BODY_TOO_LARGE
+      - DENIED
+      - TOO_MANY_REDIRECTS
+      - AUTHENTICATION_ERROR
+      - DECRYPTION
+      - INVALID_CHAR_IN_HEADER
+      - HEADER_TOO_LARGE
+      - HEADERS_INCOMPATIBLE_CONTENT_LENGTH
+      - INVALID_REQUEST
+      - REQUIRES_UPDATE
+      - UNESCAPED_CHARACTERS_IN_REQUEST_PATH
+      - MALFORMED_RESPONSE
+      - INCORRECT_ASSERTION
+      - CONNREFUSED
+      - CONNRESET
+      - DNS
+      - HOSTUNREACH
+      - NETUNREACH
+      - TIMEOUT
+      - SSL
+      - OCSP
+      - INVALID_TEST
+      - TUNNEL
+      - WEBSOCKET
+      - UNKNOWN
+      - INTERNAL_ERROR
+      type: string
+      x-enum-varnames:
+      - BODY_TOO_LARGE
+      - DENIED
+      - TOO_MANY_REDIRECTS
+      - AUTHENTICATION_ERROR
+      - DECRYPTION
+      - INVALID_CHAR_IN_HEADER
+      - HEADER_TOO_LARGE
+      - HEADERS_INCOMPATIBLE_CONTENT_LENGTH
+      - INVALID_REQUEST
+      - REQUIRES_UPDATE
+      - UNESCAPED_CHARACTERS_IN_REQUEST_PATH
+      - MALFORMED_RESPONSE
+      - INCORRECT_ASSERTION
+      - CONNREFUSED
+      - CONNRESET
+      - DNS
+      - HOSTUNREACH
+      - NETUNREACH
+      - TIMEOUT
+      - SSL
+      - OCSP
+      - INVALID_TEST
+      - TUNNEL
+      - WEBSOCKET
+      - UNKNOWN
+      - INTERNAL_ERROR
+    SyntheticsApiTestResultFailure:
+      description: The API test failure details.
+      properties:
+        code:
+          $ref: '#/components/schemas/SyntheticsApiTestFailureCode'
+        message:
+          description: The API test error message.
+          example: Error during DNS resolution (ENOTFOUND).
+          type: string
+      type: object
     SyntheticsAssertion:
       description: 'Object describing the assertions type, their associated operator,
 
@@ -10409,6 +10473,77 @@ components:
       - request
       - assertions
       type: object
+    SyntheticsBrowserTestFailureCode:
+      description: Error code that can be returned by a Synthetic test.
+      enum:
+      - API_REQUEST_FAILURE
+      - ASSERTION_FAILURE
+      - DOWNLOAD_FILE_TOO_LARGE
+      - ELEMENT_NOT_INTERACTABLE
+      - EMAIL_VARIABLE_NOT_DEFINED
+      - EVALUATE_JAVASCRIPT
+      - EVALUATE_JAVASCRIPT_CONTEXT
+      - EXTRACT_VARIABLE
+      - FORBIDDEN_URL
+      - FRAME_DETACHED
+      - INCONSISTENCIES
+      - INTERNAL_ERROR
+      - INVALID_TYPE_TEXT_DELAY
+      - INVALID_URL
+      - INVALID_VARIABLE_PATTERN
+      - INVISIBLE_ELEMENT
+      - LOCATE_ELEMENT
+      - NAVIGATE_TO_LINK
+      - OPEN_URL
+      - PRESS_KEY
+      - SERVER_CERTIFICATE
+      - SELECT_OPTION
+      - STEP_TIMEOUT
+      - SUB_TEST_NOT_PASSED
+      - TEST_TIMEOUT
+      - TOO_MANY_HTTP_REQUESTS
+      - UNAVAILABLE_BROWSER
+      - UNKNOWN
+      - UNSUPPORTED_AUTH_SCHEMA
+      - UPLOAD_FILES_ELEMENT_TYPE
+      - UPLOAD_FILES_DIALOG
+      - UPLOAD_FILES_DYNAMIC_ELEMENT
+      - UPLOAD_FILES_NAME
+      type: string
+      x-enum-varnames:
+      - API_REQUEST_FAILURE
+      - ASSERTION_FAILURE
+      - DOWNLOAD_FILE_TOO_LARGE
+      - ELEMENT_NOT_INTERACTABLE
+      - EMAIL_VARIABLE_NOT_DEFINED
+      - EVALUATE_JAVASCRIPT
+      - EVALUATE_JAVASCRIPT_CONTEXT
+      - EXTRACT_VARIABLE
+      - FORBIDDEN_URL
+      - FRAME_DETACHED
+      - INCONSISTENCIES
+      - INTERNAL_ERROR
+      - INVALID_TYPE_TEXT_DELAY
+      - INVALID_URL
+      - INVALID_VARIABLE_PATTERN
+      - INVISIBLE_ELEMENT
+      - LOCATE_ELEMENT
+      - NAVIGATE_TO_LINK
+      - OPEN_URL
+      - PRESS_KEY
+      - SERVER_CERTIFICATE
+      - SELECT_OPTION
+      - STEP_TIMEOUT
+      - SUB_TEST_NOT_PASSED
+      - TEST_TIMEOUT
+      - TOO_MANY_HTTP_REQUESTS
+      - UNAVAILABLE_BROWSER
+      - UNKNOWN
+      - UNSUPPORTED_AUTH_SCHEMA
+      - UPLOAD_FILES_ELEMENT_TYPE
+      - UPLOAD_FILES_DIALOG
+      - UPLOAD_FILES_DYNAMIC_ELEMENT
+      - UPLOAD_FILES_NAME
     SyntheticsBrowserTestResultData:
       description: Object containing results for your Synthetic browser test.
       properties:
@@ -10427,6 +10562,8 @@ components:
         error:
           description: Error returned for the browser test.
           type: string
+        failure:
+          $ref: '#/components/schemas/SyntheticsBrowserTestResultFailure'
         passed:
           description: Whether or not the browser test was conducted.
           type: boolean
@@ -10452,6 +10589,16 @@ components:
           format: double
           type: number
       type: object
+    SyntheticsBrowserTestResultFailure:
+      description: The browser test failure details.
+      properties:
+        code:
+          $ref: '#/components/schemas/SyntheticsBrowserTestFailureCode'
+        message:
+          description: The browser test error message.
+          example: Error during DNS resolution (ENOTFOUND).
+          type: string
+      type: object
     SyntheticsBrowserTestResultFull:
       description: Object returned describing a browser test result.
       properties:
@@ -10851,25 +10998,6 @@ components:
       - EDGE_LAPTOP_LARGE
       - EDGE_TABLET
       - EDGE_MOBILE_SMALL
-    SyntheticsErrorCode:
-      description: Error code that can be returned by a Synthetic test.
-      enum:
-      - NO_ERROR
-      - UNKNOWN
-      - DNS
-      - SSL
-      - TIMEOUT
-      - DENIED
-      - INCORRECT_ASSERTION
-      type: string
-      x-enum-varnames:
-      - NO_ERROR
-      - UNKNOWN
-      - DNS
-      - SSL
-      - TIMEOUT
-      - DENIED
-      - INCORRECT_ASSERTION
     SyntheticsGetAPITestLatestResultsResponse:
       description: Object with the latest Synthetic API test run.
       properties:
@@ -23630,6 +23758,11 @@ paths:
           - file: synthetics_api_test_payload.json
             name: body
           step: there is a valid "synthetics_api_test" in the system
+        synthetics_api_test_with_wrong_dns:
+          parameters:
+          - file: synthetics_api_test_with_wrong_dns.json
+            name: body
+          step: there is a "synthetics_api_test_with_wrong_dns" in the system
       x-menu-order: 1
       x-undo:
         operationId: DeleteTests
@@ -24122,6 +24255,13 @@ paths:
       tags:
       - Synthetics
       x-codegen-request-body-name: body
+      x-given:
+        synthetics_api_test_with_wrong_dns_result:
+          parameters:
+          - name: body
+            value: '{"tests": [{"public_id": "{{ synthetics_api_test_with_wrong_dns.public_id
+              }}"}]}'
+          step: the "synthetics_api_test_with_wrong_dns" is triggered
       x-menu-order: 7
       x-undo:
         type: safe

cassettes/v1/Synthetics_2658572017/Get-an-API-test-result-returns-result-with-failure-object_3671979984/frozen.json

@@ -0,0 +1 @@
+"2022-01-31T14:13:54.521Z"