pact_broker-client 1.32.0 → 1.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fc996a2d95d7c3755d063cd244b273fa5924f6956cf18b26ebe9531fa59e304
-  data.tar.gz: '018d1d764a83f040d57d6ef504a6b4229f34f3fff38cf938c8c3f2202e03cc7a'
+  metadata.gz: 780fdf6ce281a9e3d94de58bb68705d0aa4b9b9fb7262ae1331c246c8dda5d6a
+  data.tar.gz: f15abe101f78db4245f654f2f2717d8b78be861146769c83e32a655e43c3ecc8
 SHA512:
-  metadata.gz: 95944c92c42aa29803c5bd37b5b4c8526359cb910c4a983123379ac2f0482483aae75fc9179d2e6341e1931019c3f1588e1d7a385ffa628c203fd829d3137bfb
-  data.tar.gz: 5391400fa12118608718161c3ea286ffe1b3b7aebbe1eca074b999b1903b25f6a3f15e257459e35240e30faf768949d45c45a052616378507b0eaf970590ee1b
+  metadata.gz: 27c3f50858c65ea0fc07a0b88c8eee758cfeb09f37c81d01d767a040ad51b377b43dd6fc080e9ae4f08dae4d10c379a9cda9b9d1dc456f680e06f2fc87860543
+  data.tar.gz: 6ce9d5caf203b2b41d5fd665f84b43109bf0ebec81019bb2747de2723de6f0b60cc38ecadd6e6cad7a4cd43e625ea96c595475a9c8f48f8b75c3c1180ff960db

data/.github/workflows/release_gem.yml

@@ -4,6 +4,7 @@ on:
   repository_dispatch:
     types:
       - release-triggered
+  workflow_dispatch:
 
 jobs:
   test:

data/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Test
+
+on: push
+
+jobs:
+  test:
+    runs-on: "ubuntu-latest"
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version: ["2.2", "2.7"]
+        experimental: [false]
+        include:
+          - ruby_version: "3.0"
+            experimental: true
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - run: "bundle install"
+      - run: "bundle exec rake"

data/CHANGELOG.md

@@ -1,3 +1,51 @@
+<a name="v1.37.0"></a>
+### v1.37.0 (2021-03-01)
+
+#### Features
+
+* add record-deployment	 ([6e5e208](/../../commit/6e5e208))
+
+#### Bug Fixes
+
+* use refinement to add compact to Hash	 ([c2c1cab](/../../commit/c2c1cab))
+
+<a name="v1.36.0"></a>
+### v1.36.0 (2021-02-21)
+
+#### Features
+
+* **can-i-deploy**
+  * add --to-environment option	 ([05ae44c](/../../commit/05ae44c))
+
+* support version branch and build URL when publishing pacts	 ([a75f7df](/../../commit/a75f7df))
+
+<a name="v1.35.0"></a>
+### v1.35.0 (2021-01-21)
+
+#### Features
+
+* **can-i-deploy**
+  * display links to verification results in the output of can-i-deploy when using text format	 ([976950d](/../../commit/976950d))
+
+<a name="v1.34.0"></a>
+### v1.34.0 (2020-11-20)
+
+#### Features
+
+* **pact publish**
+  * strip new lines from version numbers and tags	 ([5842d24](/../../commit/5842d24))
+
+* **publish**
+  * update output text when pact already exists and merging	 ([9b849d3](/../../commit/9b849d3))
+
+<a name="v1.33.0"></a>
+### v1.33.0 (2020-11-10)
+
+#### Features
+
+* **publish**
+  * allow pacts to be merged on the server side	 ([bd80f10](/../../commit/bd80f10))
+
 <a name="v1.32.0"></a>
 ### v1.32.0 (2020-10-26)
 

data/README.md

@@ -2,7 +2,9 @@
 
 A client for the Pact Broker. Publishes and retrieves pacts, verification results, pacticipants, pacticipant versions and tags. The functionality is available via a CLI, or via Ruby Rake tasks. You can also use the [Pact CLI Docker image](https://hub.docker.com/r/pactfoundation/pact-cli).
 
-[![Build Status](https://travis-ci.org/pact-foundation/pact_broker-client.svg?branch=master)](https://travis-ci.org/pact-foundation/pact_broker-client)
+![Build status](https://github.com/pact-foundation/pact_broker-client/workflows/Test/badge.svg)
+
+[![Gem Version](https://badge.fury.io/rb/pact_broker-client.svg)](http://badge.fury.io/rb/pact_broker-client)
 
 ![Trigger update to docs.pact.io](https://github.com/pact-foundation/pact_broker-client/workflows/Trigger%20update%20to%20docs.pact.io/badge.svg)
 
@@ -16,9 +18,19 @@ Download the latest [pact-ruby-standalone][pact-ruby-standalone] package. You do
 
 Add `gem 'pact_broker-client'` to your Gemfile and run `bundle install`, or install the gem directly by running `gem install pact_broker-client`.
 
+## Connecting to a Pact Broker with a self signed certificate
+
+To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable `$SSL_CERT_FILE` or `$SSL_CERT_DIR` to a path that contains the appropriate certificate. Read more at https://docs.pact.io/pact_broker/advanced_topics/using-tls#for-non-jvm
+
 ## Usage - CLI
 
-To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable `$SSL_CERT_FILE` or `$SSL_CERT_DIR` to a path that contains the appropriate certificate.
+The Pact Broker base URL can be specified either using the environment variable `$PACT_BROKER_BASE_URL` or the `-b` or `--broker-base-url` parameters.
+
+Pact Broker authentication can be performed either using basic auth or a bearer token.
+
+Basic auth parameters can be specified using the `$PACT_BROKER_USERNAME` and `$PACT_BROKER_PASSWORD` environment variables, or the `-u` or `--broker-username` and `-p` or `--broker-password` parameters.
+
+Authentication using a bearer token can be specified using the environment variable `$PACT_BROKER_TOKEN` or the `-k` or `--broker-token` parameters. This authentication system is used by [Pactflow](pactflow.io).
 
 ### publish
 
@@ -188,7 +200,7 @@ Can I deploy all the applications in my monorepo to prod?
                                --pacticipant B --version a7e28207 \
                                --pacticipant C --version a7e28207 \
                                --to prod \
-                               --broker-base-url BROKER_BASE_URL                               
+                               --broker-base-url BROKER_BASE_URL
 
 Mobile provider use case - can I deploy version b80e7b1b of Bar, all versions of Foo with tag "prod", and the latest version tagged "prod" of any other automatically calculated dependencies together? (Eg. where Bar is a provider and Foo is a mobile consumer with multiple versions in production, and Bar also has its own providers it needs to be compatible with.)
 

data/Rakefile

@@ -31,6 +31,8 @@ end
 desc 'List provider states'
 task 'pact:list_provider_states' do
   require 'json'
+  require 'pact_broker/client/backports'
+
   puts Dir.glob("spec/pacts/**.json").collect { | pact_file |
     puts pact_file
     JSON.parse(File.read(pact_file))['interactions'].collect{ | interaction| interaction['providerState'] }

data/doc/pacts/markdown/Pact Broker Client - Pact Broker.md

@@ -2,6 +2,12 @@
 
 #### Requests from Pact Broker Client to Pact Broker
 
+* [A request for a pacticipant version](#a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_2_environments_that_aren't_test_available_for_deployment) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with 2 environments that aren't test available for deployment
+
+* [A request for a pacticipant version](#a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment
+
+* [A request for a pacticipant version](#a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_does_not_exist) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo does not exist
+
 * [A request for the compatibility matrix for a pacticipant that does not exist](#a_request_for_the_compatibility_matrix_for_a_pacticipant_that_does_not_exist)
 
 * [A request for the compatibility matrix for all versions of Foo and Bar](#a_request_for_the_compatibility_matrix_for_all_versions_of_Foo_and_Bar_given_the_pact_for_Foo_version_1.2.3_and_1.2.4_has_been_verified_by_Bar_version_4.5.6) given the pact for Foo version 1.2.3 and 1.2.4 has been verified by Bar version 4.5.6
@@ -20,6 +26,8 @@
 
 * [A request for the compatibility matrix where only the version of Foo is specified](#a_request_for_the_compatibility_matrix_where_only_the_version_of_Foo_is_specified_given_the_pact_for_Foo_version_1.2.3_has_been_verified_by_Bar_version_4.5.6_and_version_5.6.7) given the pact for Foo version 1.2.3 has been verified by Bar version 4.5.6 and version 5.6.7
 
+* [A request for the environments](#a_request_for_the_environments_given_an_environment_with_name_test_exists) given an environment with name test exists
+
 * [A request for the index resource](#a_request_for_the_index_resource)
 
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pacticipant_relations_are_present) given the pacticipant relations are present
@@ -28,6 +36,10 @@
 
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:latest-version_relation_exists_in_the_index_resource) given the pb:latest-version relation exists in the index resource
 
+* [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:pacticipant-version_and_pb:environments_relations_exist_in_the_index_resource) given the pb:pacticipant-version and pb:environments relations exist in the index resource
+
+* [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:pacticipant-version_relation_exists_in_the_index_resource) given the pb:pacticipant-version relation exists in the index resource
+
 * [A request for the index resource with the webhook relation](#a_request_for_the_index_resource_with_the_webhook_relation)
 
 * [A request for the list of the latest pacts from all consumers for the Pricing Service'](#a_request_for_the_list_of_the_latest_pacts_from_all_consumers_for_the_Pricing_Service'_given_a_latest_pact_between_Condor_and_the_Pricing_Service_exists) given a latest pact between Condor and the Pricing Service exists
@@ -42,6 +54,10 @@
 
 * [A request to create a pacticipant](#a_request_to_create_a_pacticipant)
 
+* [A request to create a pacticipant version](#a_request_to_create_a_pacticipant_version_given_version_26f353580936ad3b9baddb17b00e84f33c69e7cb_of_pacticipant_Foo_does_exist) given version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does exist
+
+* [A request to create a pacticipant version](#a_request_to_create_a_pacticipant_version_given_version_26f353580936ad3b9baddb17b00e84f33c69e7cb_of_pacticipant_Foo_does_not_exist) given version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does not exist
+
 * [A request to create a webhook for a consumer and provider](#a_request_to_create_a_webhook_for_a_consumer_and_provider_given_'Condor'_does_not_exist_in_the_pact-broker) given 'Condor' does not exist in the pact-broker
 
 * [A request to create a webhook with a JSON body and a uuid](#a_request_to_create_a_webhook_with_a_JSON_body_and_a_uuid_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker) given the 'Pricing Service' and 'Condor' already exist in the pact-broker
@@ -76,6 +92,8 @@
 
 * [A request to publish a pact with method put](#a_request_to_publish_a_pact_with_method_put_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker,_and_Condor_already_has_a_pact_published_for_version_1.3.0) given the 'Pricing Service' and 'Condor' already exist in the pact-broker, and Condor already has a pact published for version 1.3.0
 
+* [A request to record a deployment](#a_request_to_record_a_deployment_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment
+
 * [A request to register the repository URL of a pacticipant](#a_request_to_register_the_repository_URL_of_a_pacticipant_given_the_'Pricing_Service'_already_exists_in_the_pact-broker) given the 'Pricing Service' already exists in the pact-broker
 
 * [A request to register the repository URL of a pacticipant](#a_request_to_register_the_repository_URL_of_a_pacticipant_given_the_'Pricing_Service'_does_not_exist_in_the_pact-broker) given the 'Pricing Service' does not exist in the pact-broker
@@ -108,6 +126,87 @@
 
 #### Interactions
 
+<a name="a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_2_environments_that_aren&#39;t_test_available_for_deployment"></a>
+Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with 2 environments that aren't test available for deployment**, upon receiving **a request for a pacticipant version** from Pact Broker Client, with
+```json
+{
+  "method": "GET",
+  "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pb:record-deployment": [
+        {
+          "name": "prod",
+          "href": "href"
+        },
+        {
+          "name": "dev",
+          "href": "href"
+        }
+      ]
+    }
+  }
+}
+```
+<a name="a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment"></a>
+Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment**, upon receiving **a request for a pacticipant version** from Pact Broker Client, with
+```json
+{
+  "method": "GET",
+  "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pb:record-deployment": [
+        {
+          "name": "test",
+          "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST"
+        }
+      ]
+    }
+  }
+}
+```
+<a name="a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_does_not_exist"></a>
+Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo does not exist**, upon receiving **a request for a pacticipant version** from Pact Broker Client, with
+```json
+{
+  "method": "GET",
+  "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 404
+}
+```
 <a name="a_request_for_the_compatibility_matrix_for_a_pacticipant_that_does_not_exist"></a>
 Upon receiving **a request for the compatibility matrix for a pacticipant that does not exist** from Pact Broker Client, with
 ```json
@@ -164,7 +263,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -185,7 +289,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -233,7 +342,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -281,7 +395,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -329,7 +448,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -413,7 +537,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -484,7 +613,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -494,6 +628,36 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_for_the_environments_given_an_environment_with_name_test_exists"></a>
+Given **an environment with name test exists**, upon receiving **a request for the environments** from Pact Broker Client, with
+```json
+{
+  "method": "GET",
+  "path": "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pb:environments": [
+        {
+          "name": "test",
+          "href": "href"
+        }
+      ]
+    }
+  }
+}
+```
 <a name="a_request_for_the_index_resource"></a>
 Upon receiving **a request for the index resource** from Pact Broker Client, with
 ```json
@@ -611,6 +775,63 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_for_the_index_resource_given_the_pb:pacticipant-version_and_pb:environments_relations_exist_in_the_index_resource"></a>
+Given **the pb:pacticipant-version and pb:environments relations exist in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client, with
+```json
+{
+  "method": "GET",
+  "path": "/",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pb:pacticipant-version": {
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-{pacticipant}-{version}"
+      },
+      "pb:environments": {
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS"
+      }
+    }
+  }
+}
+```
+<a name="a_request_for_the_index_resource_given_the_pb:pacticipant-version_relation_exists_in_the_index_resource"></a>
+Given **the pb:pacticipant-version relation exists in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client, with
+```json
+{
+  "method": "get",
+  "path": "/",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pb:pacticipant-version": {
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-{pacticipant}-{version}"
+      }
+    }
+  }
+}
+```
 <a name="a_request_for_the_index_resource_with_the_webhook_relation"></a>
 Upon receiving **a request for the index resource with the webhook relation** from Pact Broker Client, with
 ```json
@@ -735,7 +956,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -858,6 +1084,76 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_to_create_a_pacticipant_version_given_version_26f353580936ad3b9baddb17b00e84f33c69e7cb_of_pacticipant_Foo_does_exist"></a>
+Given **version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does exist**, upon receiving **a request to create a pacticipant version** from Pact Broker Client, with
+```json
+{
+  "method": "put",
+  "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-26f353580936ad3b9baddb17b00e84f33c69e7cb",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "branch": "main",
+    "buildUrl": "http://my-ci/builds/1"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "number": "26f353580936ad3b9baddb17b00e84f33c69e7cb",
+    "branch": "main",
+    "buildUrl": "http://my-ci/builds/1",
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/some-url"
+      }
+    }
+  }
+}
+```
+<a name="a_request_to_create_a_pacticipant_version_given_version_26f353580936ad3b9baddb17b00e84f33c69e7cb_of_pacticipant_Foo_does_not_exist"></a>
+Given **version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does not exist**, upon receiving **a request to create a pacticipant version** from Pact Broker Client, with
+```json
+{
+  "method": "put",
+  "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-26f353580936ad3b9baddb17b00e84f33c69e7cb",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "branch": "main",
+    "buildUrl": "http://my-ci/builds/1"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "number": "26f353580936ad3b9baddb17b00e84f33c69e7cb",
+    "branch": "main",
+    "buildUrl": "http://my-ci/builds/1",
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/some-url"
+      }
+    }
+  }
+}
+```
 <a name="a_request_to_create_a_webhook_for_a_consumer_and_provider_given_&#39;Condor&#39;_does_not_exist_in_the_pact-broker"></a>
 Given **'Condor' does not exist in the pact-broker**, upon receiving **a request to create a webhook for a consumer and provider** from Pact Broker Client, with
 ```json
@@ -1632,6 +1928,33 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_to_record_a_deployment_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment"></a>
+Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment**, upon receiving **a request to record a deployment** from Pact Broker Client, with
+```json
+{
+  "method": "POST",
+  "path": "/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "replacedPreviousDeployedVersion": true
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "replacedPreviousDeployedVersion": true
+  }
+}
+```
 <a name="a_request_to_register_the_repository_URL_of_a_pacticipant_given_the_&#39;Pricing_Service&#39;_already_exists_in_the_pact-broker"></a>
 Given **the 'Pricing Service' already exists in the pact-broker**, upon receiving **a request to register the repository URL of a pacticipant** from Pact Broker Client, with
 ```json