Skip to content

Commit

Permalink
docs: update pact-stub-server help
Browse files Browse the repository at this point in the history
  • Loading branch information
bethesque committed May 4, 2018
1 parent 3ad58c3 commit d5757de
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Unlike the mock service, which has a Ruby DSL for managing its lifecycle, the mo

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

## Contributing
Expand Down
10 changes: 6 additions & 4 deletions lib/pact/stub_service/cli.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,19 @@ module Pact
module StubService
class CLI < Pact::MockService::CLI::CustomThor

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


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

0 comments on commit d5757de

Please sign in to comment.