Skip to content

Commit d5757de

Browse files
committed
docs: update pact-stub-server help
1 parent 3ad58c3 commit d5757de

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

README.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Unlike the mock service, which has a Ruby DSL for managing its lifecycle, the mo
102102

103103
```
104104
Usage:
105-
pact-stub-service PACT ...
105+
pact-stub-service PACT_URI ...
106106
107107
Options:
108108
-p, [--port=PORT] # Port on which to run the service
@@ -115,11 +115,15 @@ Options:
115115
[--sslkey=SSLKEY] # Specify the path to the SSL key to use when running the service over HTTPS
116116
117117
Description:
118-
Start a stub service with the given pact file(s). Where multiple matching interactions are found, the
119-
interactions will be sorted by response status, and the first one will be returned. This may lead to some
120-
non-deterministic behaviour. If you are having problems with this, please raise it on the pact-dev google
121-
group, and we can discuss some potential enhancements. Note that only versions 1 and 2 of the pact
122-
specification are currently supported.
118+
Start a stub service with the given pact file(s). Pact URIs may be local file paths or HTTP.
119+
Include any basic auth details in the URL using the format https://USERNAME:PASSWORD@URI.
120+
Where multiple matching interactions are found, the interactions will be sorted by
121+
response status, and the first one will be returned. This may lead to some non-deterministic
122+
behaviour. If you are having problems with this, please raise it on the pact-dev google group,
123+
and we can discuss some potential enhancements.
124+
Note that only versions 1 and 2 of the pact specification are currently fully supported.
125+
Pacts using the v3 format may be used, however, any matching features added in v4 will
126+
currently be ignored.
123127
```
124128

125129
## Contributing

lib/pact/stub_service/cli.rb

+6-4
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,19 @@ module Pact
1010
module StubService
1111
class CLI < Pact::MockService::CLI::CustomThor
1212

13-
desc 'PACT ...', "Start a stub service with the given pact file(s)."
13+
desc 'PACT_URI ...', "Start a stub service with the given pact file(s)."
1414
long_desc <<-DOC
15-
Start a stub service with the given pact file(s).
15+
Start a stub service with the given pact file(s). Pact URIs may be local file paths or HTTP.
16+
Include any basic auth details in the URL using the format https://USERNAME:PASSWORD@URI.
1617
Where multiple matching interactions are found, the interactions will be sorted by
1718
response status, and the first one will be returned. This may lead to some non-deterministic
1819
behaviour. If you are having problems with this, please raise it on the pact-dev google group,
1920
and we can discuss some potential enhancements.
20-
Note that only versions 1 and 2 of the pact specification are currently supported.
21+
Note that only versions 1 and 2 of the pact specification are currently fully supported.
22+
Pacts using the v3 format may be used, however, any matching features added in v4 will
23+
currently be ignored.
2124
DOC
2225

23-
2426
method_option :port, aliases: "-p", desc: "Port on which to run the service"
2527
method_option :host, aliases: "-h", desc: "Host on which to bind the service", default: 'localhost'
2628
method_option :log, aliases: "-l", desc: "File to which to log output"

0 commit comments

Comments
 (0)