Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the documentation to point the Pact Broker method to the brok… #305

Conversation

lmasterman
Copy link

…er root URI as the expected relationships do not exist at the pact file itself

@lmasterman lmasterman force-pushed the feature/documentation-broker-update branch from 460c163 to 75f5106 Compare June 29, 2021 09:24
@lmasterman lmasterman closed this Jun 29, 2021
@bethesque
Copy link
Member

Hm. That doesn't seem right. Perhaps we need to alias that method? When fetching a particular pact, it makes sense to have a method called "PactURI" (as the other libraries do) but when fetching the general pacts for verification from the broker, I would expect to set a "PactBrokerBaseURI" (as the other libraries do). Can we make this happen?

@lmasterman
Copy link
Author

Yeah, I realised it was incorrect just after submitting the pull request, the PactBroker() method takes a base Uri, my confusion came from muddling two separate documentation sources on setting up the pact-net library with a broker and thinking the full Uri including path was sent to the PactBroker() method, it would perhaps be made clearer if there was a commented or case for utilising the broker method instead of PactUri() here?

@bethesque
Copy link
Member

There are two use cases - one where you verify a specific pact at a known URL (from the webhook, when a pact changes) and one where you're verifying all the pacts for a provider (when the provider changes).

I've got a request open to make these docs clearer #301

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants