pact_broker-client 1.45.0 → 1.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99a06a67fbe9da6f970649c5159443669ed9ce419911e6178594944467255dd0
-  data.tar.gz: c45dcfa2fd158febe01b9094e2125b4a1637c716da3a6d11d3bd13a8ce19867c
+  metadata.gz: b31de7cb8fa97a019e49a5ff8fc37683ed0116980a40cdddb37eb1cd0a52a606
+  data.tar.gz: 32278f6e5d47e0ead01215df9d59fc7a63843c106739b249e68b026ea5a0f31b
 SHA512:
-  metadata.gz: 6da2ec04fc73a54ae53bebc62ddb5ddfe1fe1db17b1f94d22a3e195edfb756ad6330e9a99ebfeb1a6f5d20be71c92df4c16c0a808a409623b9600fb59e2e6385
-  data.tar.gz: c714b39a69e0f96ffccabe9b6bc3097c0401a6c1931a0de89e57eae7c1e0c04ef5133e1c3d124df49b2dd294bdd90fe2415baeba365e1bf44fc40b45b4602164
+  metadata.gz: a9fb4c7691da7685d7d913678213a1a0576bc09f6eb118e54fec6da3fdf07bbd7c25e7d5d9f0156a700faed0a7ba16610f5f456320025fcbe991b512448d6c90
+  data.tar.gz: 11c9f1500fe89aebef11f79ee79fa2e3f65af16cd92c8616d90d7adc625d000269a010ea9658d0579db7c0afbc1d164a3abffab4139fc6ff628a0ca6464f2f00

data/.github/workflows/test.yml

@@ -27,7 +27,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        feature: ["", "publish_contracts", "deployments"]
+        feature: ["", "publish_contracts"]
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
@@ -42,3 +42,17 @@ jobs:
           PACT_BROKER_TOKEN: ${{ secrets.PACTFLOW_PACT_OSS_TOKEN }}
           PACT_BROKER_FEATURES: ${{ matrix.feature }}
           TEST_FEATURE: ${{ matrix.feature }}
+  can-i-deploy:
+    runs-on: "ubuntu-latest"
+    needs: pact
+    steps:
+      - run: |
+          docker run --rm \
+           -e PACT_BROKER_BASE_URL=https://pact-oss.pactflow.io \
+           -e PACT_BROKER_TOKEN \
+            pactfoundation/pact-cli:latest \
+            broker can-i-deploy \
+            --pacticipant "Pact Broker Client" --version ${GITHUB_SHA} \
+            --pacticipant "Pact Broker" --latest master
+        env:
+          PACT_BROKER_TOKEN: ${{ secrets.PACTFLOW_PACT_OSS_TOKEN }}

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+<a name="v1.48.0"></a>
+### v1.48.0 (2021-08-04)
+
+#### Features
+
+* **can-i-deploy**
+  * remove feature toggle for --ignore option	 ([6e7edd8](/../../commit/6e7edd8))
+
+<a name="v1.47.1"></a>
+### v1.47.1 (2021-07-20)
+
+#### Bug Fixes
+
+* **verification-required**
+  * require a verification when either of the specified versions does not exist	 ([031d232](/../../commit/031d232))
+
+<a name="v1.47.0"></a>
+### v1.47.0 (2021-07-09)
+
+#### Features
+
+* enabled deployment, release and environment commands without a feature toggle	 ([bd64caa](/../../commit/bd64caa))
+* update relations used for currently deploy/currently supported versions	 ([6f6ca2f](/../../commit/6f6ca2f))
+
+<a name="v1.46.0"></a>
+### v1.46.0 (2021-06-24)
+
+#### Features
+
+* support specifying team UUID when creating a webhook in Pactflow	 ([c4201e1](/../../commit/c4201e1))
+
 <a name="v1.45.0"></a>
 ### v1.45.0 (2021-06-16)
 

data/README.md

@@ -78,44 +78,44 @@ Usage:
   pact-broker can-i-deploy -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL
 
 Options:
-  -a, --pacticipant=PACTICIPANT            
+  -a, --pacticipant=PACTICIPANT
                 # The pacticipant name. Use once for each pacticipant being checked.
-  -e, [--version=VERSION]                  
+  -e, [--version=VERSION]
                 # The pacticipant version. Must be entered after the --pacticipant that it relates to.
-      [--ignore=IGNORE]                    
-                # The pacticipant name to ignore. Use once for each pacticipant being ignored. 
-                A specific version can be ignored by also specifying a --version after the 
+      [--ignore=IGNORE]
+                # The pacticipant name to ignore. Use once for each pacticipant being ignored.
+                A specific version can be ignored by also specifying a --version after the
                 pacticipant name option.
-  -l, [--latest=[TAG]]                     
-                # Use the latest pacticipant version. Optionally specify a TAG to use the 
+  -l, [--latest=[TAG]]
+                # Use the latest pacticipant version. Optionally specify a TAG to use the
                 latest version with the specified tag.
-      [--to=TAG]                           
+      [--to=TAG]
                 # This is too hard to explain in a short sentence. Look at the examples.
-  -o, [--output=OUTPUT]                    
+  -o, [--output=OUTPUT]
                 # json or table
-                                           
+
                 # Default: table
-      [--retry-while-unknown=TIMES]        
-                # The number of times to retry while there is an unknown verification result 
+      [--retry-while-unknown=TIMES]
+                # The number of times to retry while there is an unknown verification result
                 (ie. the provider verification is likely still running)
-                                           
+
                 # Default: 0
-      [--retry-interval=SECONDS]           
+      [--retry-interval=SECONDS]
                 # The time between retries in seconds. Use in conjuction with --retry-while-unknown
-                                           
+
                 # Default: 10
-      [--dry-run], [--no-dry-run]          
+      [--dry-run], [--no-dry-run]
                 # When enabled, always exits process with a success code. Can also be enabled by setting
                 the environment variable PACT_BROKER_CAN_I_DEPLOY_DRY_RUN=true.
-  -b, --broker-base-url=BROKER_BASE_URL    
+  -b, --broker-base-url=BROKER_BASE_URL
                 # The base URL of the Pact Broker
-  -u, [--broker-username=BROKER_USERNAME]  
+  -u, [--broker-username=BROKER_USERNAME]
                 # Pact Broker basic auth username
-  -p, [--broker-password=BROKER_PASSWORD]  
+  -p, [--broker-password=BROKER_PASSWORD]
                 # Pact Broker basic auth password
-  -k, [--broker-token=BROKER_TOKEN]        
+  -k, [--broker-token=BROKER_TOKEN]
                 # Pact Broker bearer token
-  -v, [--verbose], [--no-verbose]          
+  -v, [--verbose], [--no-verbose]
                 # Verbose output. Default: false
 ```
 
@@ -235,27 +235,19 @@ Usage:
 
 Options:
   -X, --request=METHOD
-            # HTTP method
+            # Webhook HTTP method
   -H, [--header=one two three]
-            # Header
+            # Webhook Header
   -d, [--data=DATA]
-            # Data
+            # Webhook payload (file or string)
   -u, [--user=USER]
-            # Basic auth username and password eg. username:password
+            # Webhook basic auth username and password eg. username:password
       [--consumer=CONSUMER]
             # Consumer name
       [--provider=PROVIDER]
             # Provider name
-  -b, --broker-base-url=BROKER_BASE_URL
-            # The base URL of the Pact Broker
-      [--broker-username=BROKER_USERNAME]
-            # Pact Broker basic auth username
-  -p, [--broker-password=BROKER_PASSWORD]
-            # Pact Broker basic auth password
-  -k, [--broker-token=BROKER_TOKEN]
-            # Pact Broker bearer token
       [--description=DESCRIPTION]
-            # The description of the webhook
+            # Webhook description
       [--contract-content-changed], [--no-contract-content-changed]
             # Trigger this webhook when the pact content changes
       [--contract-published], [--no-contract-published]
@@ -266,6 +258,16 @@ Options:
             # Trigger this webhook when a failed provider verification result is published
       [--provider-verification-succeeded], [--no-provider-verification-succeeded]
             # Trigger this webhook when a successful provider verification result is published
+      [--team-uuid=UUID]
+            # UUID of the Pactflow team to which the webhook should be assigned (Pactflow only)
+  -b, --broker-base-url=BROKER_BASE_URL
+            # The base URL of the Pact Broker
+  -u, [--broker-username=BROKER_USERNAME]
+            # Pact Broker basic auth username
+  -p, [--broker-password=BROKER_PASSWORD]
+            # Pact Broker basic auth password
+  -k, [--broker-token=BROKER_TOKEN]
+            # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
             # Verbose output. Default: false
 
@@ -283,27 +285,19 @@ Usage:
 
 Options:
   -X, --request=METHOD
-            # HTTP method
+            # Webhook HTTP method
   -H, [--header=one two three]
-            # Header
+            # Webhook Header
   -d, [--data=DATA]
-            # Data
+            # Webhook payload (file or string)
   -u, [--user=USER]
-            # Basic auth username and password eg. username:password
+            # Webhook basic auth username and password eg. username:password
       [--consumer=CONSUMER]
             # Consumer name
       [--provider=PROVIDER]
             # Provider name
-  -b, --broker-base-url=BROKER_BASE_URL
-            # The base URL of the Pact Broker
-      [--broker-username=BROKER_USERNAME]
-            # Pact Broker basic auth username
-  -p, [--broker-password=BROKER_PASSWORD]
-            # Pact Broker basic auth password
-  -k, [--broker-token=BROKER_TOKEN]
-            # Pact Broker bearer token
       [--description=DESCRIPTION]
-            # The description of the webhook
+            # Webhook description
       [--contract-content-changed], [--no-contract-content-changed]
             # Trigger this webhook when the pact content changes
       [--contract-published], [--no-contract-published]
@@ -314,6 +308,16 @@ Options:
             # Trigger this webhook when a failed provider verification result is published
       [--provider-verification-succeeded], [--no-provider-verification-succeeded]
             # Trigger this webhook when a successful provider verification result is published
+      [--team-uuid=UUID]
+            # UUID of the Pactflow team to which the webhook should be assigned (Pactflow only)
+  -b, --broker-base-url=BROKER_BASE_URL
+            # The base URL of the Pact Broker
+  -u, [--broker-username=BROKER_USERNAME]
+            # Pact Broker basic auth username
+  -p, [--broker-password=BROKER_PASSWORD]
+            # Pact Broker basic auth password
+  -k, [--broker-token=BROKER_TOKEN]
+            # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
             # Verbose output. Default: false
       --uuid=UUID

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

@@ -2,6 +2,14 @@
 
 #### 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_exists_with_a_test_environment_available_for_release) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for release
+
+* [A request for an environment](#a_request_for_an_environment_given_an_environment_with_name_test_and_UUID_16926ef3-590f-4e3f-838e-719717aa88c9_exists) given an environment with name test and UUID 16926ef3-590f-4e3f-838e-719717aa88c9 exists
+
 * [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 +28,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 +38,8 @@
 
 * [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)
@@ -74,6 +86,10 @@
 
 * [A request to list the latest pacts](#a_request_to_list_the_latest_pacts_given_a_pact_between_Condor_and_the_Pricing_Service_exists) given a pact between Condor and the Pricing Service exists
 
+* [A request to list the versions deployed to an environment for a pacticipant name and target](#a_request_to_list_the_versions_deployed_to_an_environment_for_a_pacticipant_name_and_target_given_an_version_is_deployed_to_environment_with_UUID_16926ef3-590f-4e3f-838e-719717aa88c9_with_target_customer-1) given an version is deployed to environment with UUID 16926ef3-590f-4e3f-838e-719717aa88c9 with target customer-1
+
+* [A request to mark a deployed version as not currently deploye](#a_request_to_mark_a_deployed_version_as_not_currently_deploye_given_a_currently_deployed_version_exists) given a currently deployed version exists
+
 * [A request to publish a pact](#a_request_to_publish_a_pact_given_'Condor'_already_exist_in_the_pact-broker,_but_the_'Pricing_Service'_does_not) given 'Condor' already exist in the pact-broker, but the 'Pricing Service' does not
 
 * [A request to publish a pact](#a_request_to_publish_a_pact_given_the_'Pricing_Service'_already_exists_in_the_pact-broker) given the 'Pricing Service' already exists in the pact-broker
@@ -84,6 +100,10 @@
 
 * [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 record a release](#a_request_to_record_a_release_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
@@ -116,6 +136,127 @@
 
 #### 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_exists_with_a_test_environment_available_for_release"></a>
+Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for release**, 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-release": [
+        {
+          "name": "test",
+          "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-RECORD-RELEASE-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST"
+        }
+      ]
+    }
+  }
+}
+```
+<a name="a_request_for_an_environment_given_an_environment_with_name_test_and_UUID_16926ef3-590f-4e3f-838e-719717aa88c9_exists"></a>
+Given **an environment with name test and UUID 16926ef3-590f-4e3f-838e-719717aa88c9 exists**, upon receiving **a request for an environment** from Pact Broker Client, with
+```json
+{
+  "method": "GET",
+  "path": "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENT-16926ef3-590f-4e3f-838e-719717aa88c9",
+  "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:currently-deployed-deployed-versions": {
+        "href": "http://localhost:1234/PLACEHOLDER-ENVIRONMENT-CURRENTLY-DEPLOYED-16926ef3-590f-4e3f-838e-719717aa88c9"
+      }
+    }
+  }
+}
+```
 <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
@@ -537,6 +678,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
@@ -654,6 +825,36 @@ 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
@@ -1666,6 +1867,72 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_to_list_the_versions_deployed_to_an_environment_for_a_pacticipant_name_and_target_given_an_version_is_deployed_to_environment_with_UUID_16926ef3-590f-4e3f-838e-719717aa88c9_with_target_customer-1"></a>
+Given **an version is deployed to environment with UUID 16926ef3-590f-4e3f-838e-719717aa88c9 with target customer-1**, upon receiving **a request to list the versions deployed to an environment for a pacticipant name and target** from Pact Broker Client, with
+```json
+{
+  "method": "GET",
+  "path": "/PLACEHOLDER-ENVIRONMENT-CURRENTLY-DEPLOYED-16926ef3-590f-4e3f-838e-719717aa88c9",
+  "query": "pacticipant=Foo",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_embedded": {
+      "deployedVersions": [
+        {
+          "target": "customer-1",
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/PLACEHOLDER-DEPLOYED-VERSION-ff3adecf-cfc5-4653-a4e3-f1861092f8e0"
+            }
+          }
+        }
+      ]
+    }
+  }
+}
+```
+<a name="a_request_to_mark_a_deployed_version_as_not_currently_deploye_given_a_currently_deployed_version_exists"></a>
+Given **a currently deployed version exists**, upon receiving **a request to mark a deployed version as not currently deploye** from Pact Broker Client, with
+```json
+{
+  "method": "PATCH",
+  "path": "/PLACEHOLDER-DEPLOYED-VERSION-ff3adecf-cfc5-4653-a4e3-f1861092f8e0",
+  "headers": {
+    "Content-Type": "application/merge-patch+json"
+  },
+  "body": {
+    "currentlyDeployed": false
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "currentlyDeployed": false,
+    "_embedded": {
+      "version": {
+        "number": "2"
+      }
+    }
+  }
+}
+```
 <a name="a_request_to_publish_a_pact_given_&#39;Condor&#39;_already_exist_in_the_pact-broker,_but_the_&#39;Pricing_Service&#39;_does_not"></a>
 Given **'Condor' already exist in the pact-broker, but the 'Pricing Service' does not**, upon receiving **a request to publish a pact** from Pact Broker Client, with
 ```json
@@ -1854,6 +2121,54 @@ 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": {
+    "target": "blue"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "target": "blue"
+  }
+}
+```
+<a name="a_request_to_record_a_release_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 release** from Pact Broker Client, with
+```json
+{
+  "method": "POST",
+  "path": "/HAL-REL-PLACEHOLDER-PB-RECORD-RELEASE-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  }
+}
+```
 <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
@@ -2264,7 +2579,6 @@ Given **the 'Pricing Service' and 'Condor' already exist in the pact-broker**, u
       }
     ],
     "request": {
-      "url": null,
       "method": "POST",
       "headers": {
         "Foo": "bar",