Skip to content

Commit

Permalink
docs: add bearer token information
Browse files Browse the repository at this point in the history
  • Loading branch information
bethesque committed May 23, 2019
1 parent feeafdc commit e3c3479
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,7 @@ new Verifier().verifyProvider(opts).then(function () {
| `providerStatesSetupUrl` | false | string | DEPRECATED (see `stateHandlers`). URL to call with a POST request for each `providerState` defined in a pact (see below for more info). |
| `pactBrokerUsername` | false | string | Username for Pact Broker basic authentication |
| `pactBrokerPassword` | false | string | Password for Pact Broker basic authentication |
| `pactBrokerToken` | false | string | Bearer token for Pact Broker authentication |
| `publishVerificationResult` | false | boolean | Publish verification result to Broker | boolean |
| `providerVersion` | false | string | Provider version, required to publish verification results to a broker |
| `customProviderHeaders` | false | array of strings | Header(s) to add to any requests to the provider service. eg `Authorization: Basic cGFjdDpwYWN0`. All interactions will receive the header. See `requestFilter` for when more flexiblility is required in modifying the request to the provider. |
Expand Down Expand Up @@ -424,6 +425,8 @@ pact.publishPacts(opts)).then(function () {
| `pactBroker` | `true` | string | The base URL of the Pact Broker. eg. https://test.pact.dius.com.au. Required. |
| `pactBrokerUsername` | `false` | string | Username for Pact Broker basic authentication. Optional |
| `pactBrokerPassword` | `false` | string | Password for Pact Broker basic authentication. Optional |
| `pactBrokerToken` | `false` | string | Bearer token for Pact Broker authentication. Optional |

| `consumerVersion` | `true` | string | The consumer application version; e.g. '1.0.0-cac389f'. ([See more info on versioning](https://docs.pact.io/getting_started/versioning_in_the_pact_broker)) | |
| `tags` | `false` | array of strings | Tag your pacts, often used with your branching, release or environment strategy e.g. ['prod', 'test'] |

Expand Down

0 comments on commit e3c3479

Please sign in to comment.