Skip to content

Commit c70573c

Browse files
YOU54Fsergeyklay
authored andcommitted
chore(docs): update provider verifier options table
- Table was mismatched, cli args were the python args and some missing - updated links to examples
1 parent fc6ced8 commit c70573c

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -485,13 +485,26 @@ assert success == 0
485485
```
486486

487487
The parameters for this differ slightly in naming from their CLI equivalents:
488-
| CLI | native Python |
488+
| CLI | native Python | notes |
489489
|-----------------|-------------------------------------------------------------------------------------------------|
490-
| `consumer_tags` | `consumer-version-tag` |
491-
| `provider_tags` | `provider-version-tag` |
492-
| `custom-provider-header` | `headers` |
493-
494-
You can see more details in the [e2e examples](https://github.com/pact-foundation/pact-python/tree/master/examples/e2e/tests/provider/test_provider.py).
490+
| `--log-dir` | `log_dir` ||
491+
| `--log-level` | `log_level` ||
492+
| `--provider-app-version` | `provider_app_version` ||
493+
| `--headers` | `custom_provider_headers` ||
494+
| `--consumer-version-tag` | `consumer_tags` ||
495+
| `--provider-version-tag` | `provider_tags` ||
496+
| `--provider-states-setup-url` | `provider_states_setup_url` ||
497+
| `--verbose` | `verbose` ||
498+
| `--consumer-version-selector` | `consumer_selectors` | takes an untyped dict of consumer version selectors and converts to json |
499+
| `--publish-verification-results` | `publish_verification_results` | recommended only to set in CI |
500+
| `--provider-version-branch` | `provider_version_branch` | recommended to set |
501+
502+
503+
You can see more details in the examples
504+
505+
- [`examples/message/tests/provider/test_message_provider.py`](`examples/message/tests/provider/test_message_provider.py`)
506+
- [`examples/flask_provider/tests/provider/test_provider.py`](`examples/flask_provider/tests/provider/test_provider.py`)
507+
- [`examples/fastapi_provider/tests/provider/test_provider.py`](`examples/fastapi_provider/tests/provider/test_provider.py`)
495508

496509
### Provider States
497510
In many cases, your contracts will need very specific data to exist on the provider

0 commit comments

Comments
 (0)