Sha256: f56873aec0799d34ff38b262a3eb6885cb05dcc0554df62c028ba4d50e61a08c

Contents?: true

Size: 1.65 KB

Versions: 36

Compression:

Stored size: 1.65 KB

Contents

# Can I Deploy

Allowed methods: `GET`

A simplified resource that accepts the same parameters as the basic usage of the `can-i-deploy` CLI command.

**Parameters**:

* _pacticipant_: The name of the pacticipant (application) you want to deploy (required).
* _version_: The version of the pacticipant (application) you want to deploy (required).
* _environment_: The name of the environment into which the pacticipant (application) is to be deployed. 
* _to_: The tag used to identify the environment into which you wish to deploy the application (eg. `test` or `prod`). Deprecated - use the `environment=ENVIRONMENT` parameter in preference to the `to=TAG` parameter as deployments and environments are now explictly supported.
* _ignore[]_: The name of the pacticipant to ignore when determining if it is safe to deploy (optional). May be used multiple times. eg `ignore[]=foo&ignore[]=bar`
* _ignore[][pacticipant]_ and _ignore[][version]_: When ignoring a specific pacticipant version, the name and version of the application to ignore may be specified using "nested" param names syntax. eg. `ignore[][pacticipant]=foo&ignore[][version]=2ac5a946&ignore[][pacticipant]=bar`


If you have an environment that you identify with the name `prod`, and each time you deployed an application to the prod environment you recorded the deployment of relevant application version in the Pact Broker using `record-deployment`, then calling `/can-i-deploy?pacticipant=Foo&version=734137278d&environment=prod` will check that version 734137278d of Foo has a successful verification result with each of the integrated application versions that are currently in prod. That is, it is safe to deploy.

Version data entries

36 entries across 36 versions & 1 rubygems

Version Path
pact_broker-2.112.0 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.111.0 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.109.1 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.109.0 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.108.0 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.107.1 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.107.0 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.107.0.beta.1 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.106.0 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.105.0 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.104.0 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.103.0 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.102.2 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.102.1 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.102.0 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.101.0 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.100.0 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.99.0 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.98.0 lib/pact_broker/doc/views/can-i-deploy.markdown
pact_broker-2.97.0 lib/pact_broker/doc/views/can-i-deploy.markdown