Skip to main content

Module proto_v2

Module proto_v2 

Source

Modules§

body
Nested message and enum types in Body.
catalogue_entry
Nested message and enum types in CatalogueEntry.
field_value
Nested message and enum types in FieldValue.
generate_content_request
Nested message and enum types in GenerateContentRequest.
init_plugin_response
Nested message and enum types in InitPluginResponse.
interaction_response
Nested message and enum types in InteractionResponse.
metadata_value
Nested message and enum types in MetadataValue.
pact_plugin_client
Generated client implementations.
pact_plugin_server
Generated server implementations.
plugin_host_client
Generated client implementations.
plugin_host_server
Generated server implementations.
start_mock_server_response
Nested message and enum types in StartMockServerResponse.
verification_preparation_response
Nested message and enum types in VerificationPreparationResponse.
verification_result_item
Nested message and enum types in VerificationResultItem.
verify_interaction_response
Nested message and enum types in VerifyInteractionResponse.

Structs§

Body
Message representing a request, response or message body
Catalogue
Catalogue of Core Pact + Plugin features
CatalogueEntry
Entry to be added to the core catalogue. Each entry describes one of the features the plugin provides. Entries will be stored in the catalogue under the key “plugin/$name/$type/$key”.
CompareContentsRequest
Request to preform a comparison on an actual body given the expected one
CompareContentsResponse
Response to the CompareContentsRequest with the results of the comparison
ConfigureInteractionRequest
Request to configure/setup an interaction so that it can be verified later
ConfigureInteractionResponse
Response to the configure/setup an interaction request
ContentMismatch
A mismatch for an particular item of content
ContentMismatches
List of content mismatches
ContentTypeMismatch
Indicates that there was a mismatch with the content type
FieldValue
A single value being matched or generated at the field/element level.
GenerateContentRequest
Request to generate the contents using any defined generators
GenerateContentResponse
Generated body/message response
GenerateFieldRequest
Request to generate a single value using a plugin-provided generator. Generators are pure functions of this request: anything from the host they need arrives in testContext or is fetched with an explicit callback. See proposal 006.
GenerateFieldResponse
Response to the GenerateFieldRequest with the generated value
Generator
Example generator
HostCompareContentsRequest
Callback request from a plugin to invoke a content matcher capability - host-provided or owned by another plugin - resolved by catalogue entry key. See proposal 007 (Driver-plugin callback model).
HostGenerateContentRequest
Callback request from a plugin to invoke a content generator capability - host-provided or owned by another plugin - resolved by catalogue entry key. See proposal 007 (Driver-plugin callback model).
HostGenerateFieldRequest
Callback request from a plugin to invoke a field-level generator - host-provided or owned by another plugin - resolved by catalogue entry key. See proposals 006 and 007.
HostMatchFieldRequest
Callback request from a plugin to invoke a field-level matching rule - host-provided (one of the standard Pact rules) or owned by another plugin - resolved by catalogue entry key. See proposals 006 (Field-level matchers and generators) and 007 (Driver-plugin callback model).
InitPluginFailure
Failure result of initialising the plugin
InitPluginRequest
Request to verify the plugin has loaded OK
InitPluginResponse
Response to init plugin, providing either the negotiated success response or a structured failure
InitPluginSuccess
Successful result of initialising the plugin
InteractionContents
Structured interaction data sent to V2 plugins in place of raw pact JSON. Contains only the data the plugin needs, eliminating the need for plugins to parse full Pact documents.
InteractionData
Interaction request data to be sent or received for verification
InteractionResponse
Response to the configure/setup an interaction request
LogMessage
Structured log record emitted by a plugin and forwarded to the driver via the Log RPC
MatchFieldRequest
Request to apply a plugin-provided matching rule to a single value. The plugin sees the value, its path and the rule’s own configuration, but not the document that contains it - a rule that needs the surrounding document is a content matcher. See proposal 006.
MatchFieldResponse
Response to the MatchFieldRequest with the result of applying the rule
MatchingRule
Represents a matching rule
MatchingRules
List of matching rules
MetadataValue
Request metadata value. Will either be a JSON-like value, or binary data
MockServerDetails
Details on a running mock server
MockServerRequest
Request for a running mock server by ID
MockServerResult
Result of a request that the mock server received
MockServerResults
Matching results of the mock server.
PluginConfiguration
Plugin configuration added to the pact file by the ConfigureInteraction step
StartMockServerRequest
Request to start a mock server
StartMockServerResponse
Response to the start mock server request
VerificationPreparationRequest
Request to prepare an interaction for verification
VerificationPreparationResponse
Response for the prepare an interaction for verification request
VerificationResult
Result of running the verification
VerificationResultItem
VerifyInteractionRequest
Request data to verify an interaction
VerifyInteractionResponse
Result of running the verification