pact_verifier 1.3.4

Pact-Rust support library that implements provider verification functions
Documentation 
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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://pact.io/pact_verifier/verifier-results.schema.json",
  "description": "Schema for verification results in JSON format",
  "type": "object",
  "properties": {
    "result": {
      "description": "Boolean value for the overall result",
      "type": "boolean"
    },
    "notices": {
      "description": "All notices returned from the Pact broker",
      "type": "object",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "output": {
      "description": "All captured output from the verification process",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "errors": {
      "description": "List of all verification errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "interaction": {
            "description": "interaction description that failed",
            "type": "string"
          },
          "mismatch": {
            "description": "Will either be an error when the verification could not be completed, or a mismatch",
            "type": "object",
            "properties": {
              "type": {
                "description": "The type of mismatch/error",
                "enum": ["mismatches", "error"]
              },
              "mismatches": {
                "description": "The mismatches that occurred. Will be present if type=mismatches",
                "type": "array",
                "items": {
                  "$ref": "#/$defs/mismatch"
                }
              },
              "message": {
                "description": "The error message (if type=error)",
                "type": "string"
              },
              "interactionId": {
                "description": "Interaction ID from the Pact broker",
                "type": "string"
              }
            }
          }
        }
      }
    },
    "pendingErrors": {
      "description": "List of all pending verification errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "interaction": {
            "description": "interaction description that failed",
            "type": "string"
          },
          "mismatch": {
            "description": "Will either be an error when the verification could not be completed, or a mismatch",
            "type": "object",
            "properties": {
              "type": {
                "description": "The type of mismatch/error",
                "enum": ["mismatches", "error"]
              },
              "mismatches": {
                "description": "The mismatches that occurred. Will be present if type=mismatches",
                "type": "array",
                "items": {
                  "$ref": "#/$defs/mismatch"
                }
              },
              "message": {
                "description": "The error message (if type=error)",
                "type": "string"
              },
              "interactionId": {
                "description": "Interaction ID from the Pact broker",
                "type": "string"
              }
            }
          }
        }
      }
    }
},
  "required": [ "result" ],
  "$defs": {
    "mismatch": {
      "description": "Mismatch that occurred from verification",
      "type": "object",
      "properties": {
        "type": {
          "description": "The type of mismatch that occurred",
          "enum": [ "MethodMismatch", "PathMismatch", "StatusMismatch", "QueryMismatch", "HeaderMismatch", "BodyTypeMismatch", "BodyMismatch", "MetadataMismatch" ]
        },
        "expected": {
          "description": "The expected value"
        },
        "actual": {
          "description": "The actual value"
        },
        "mismatch" : {
          "description": "Description of the mismatch",
          "type": "string"
        },
        "parameter" : {
          "description": "The query parameter that the mismatch is for (type=QueryMismatch)",
          "type": "string"
        },
        "key" : {
          "description": "The header/metadata that the mismatch is for (type=HeaderMismatch or MetadataMismatch)",
          "type": "string"
        },
        "expectedBody": {
          "description": "The expected body (type=BodyTypeMismatch)",
          "type": "object"
        },
        "actualBody": {
          "description": "The actual body (type=BodyTypeMismatch)",
          "type": "object"
        },
        "path" : {
          "description": "The JSON-Path like expression that the mismatch is for (type=BodyMismatch)",
          "type": "string"
        }
      }
    }
  }
}