File tree Expand file tree Collapse file tree 4 files changed +7
-7
lines changed
Expand file tree Collapse file tree 4 files changed +7
-7
lines changed Original file line number Diff line number Diff line change @@ -19,14 +19,15 @@ You can find more information at the [GitHub page](https://github.com/EXXETA/ope
1919
2020## Usage
2121
22- The image will always run openapi-cop on port 8888 of the container . You
22+ Inside the container, openapi-cop will listen on 0.0.0.0 and port 8888 . You
2323should [ expose] ( https://docs.docker.com/config/containers/container-networking/ ) this port to the host. Make sure
2424as well that the container running openapi-cop has access to the target server (see TARGET below).
2525
2626The image accepts the following environment variables, which correspond to the
2727same [ openapi-cop CLI flags] ( https://github.com/EXXETA/openapi-cop#cli-usage ) :
2828
29- - ` TARGET ` : The URI of the target server. Must include the port, e.g. http:\/\/ somehostname:1234.
29+ - ` TARGET ` : The URI of the target server. Must include the port, e.g. http:\/\/ somehostname:1234. Note that HTTPS is not
30+ currently supported. If you wish to use HTTPS, put openapi-cop behind a SSL proxy.
3031- ` FILE ` : The file path or URI pointing to the OpenAPI definition file. Supports JSON or YAML.
3132- ` DEFAULT_FORBID_ADDITIONAL_PROPERTIES ` : When set, additional properties that are not present in the OpenAPI definition
3233 are not allowed.
Original file line number Diff line number Diff line change 1414 "compile" : " tsc -p ." ,
1515 "fix" : " gts fix" ,
1616 "start" : " node build/src/cli" ,
17- "dev-start" : " npm run compile && node build/src/cli --port 9000 --file" ,
17+ "dev-start" : " npm run compile && node build/src/cli --port 8889 --file" ,
1818 "pretest" : " npm run compile" ,
1919 "test" : " jest --forceExit --detectOpenHandles --maxWorkers=10" ,
2020 "test:deps" : " depcheck" ,
Original file line number Diff line number Diff line change 3131 "compile" : " tsc -p ." ,
3232 "fix" : " gts fix" ,
3333 "start" : " node build/src/cli" ,
34- "dev-start" : " npm run compile && node build/src/cli --port 3000 --target \" http://localhost:8889\" --file" ,
34+ "dev-start" : " npm run compile && node build/src/cli --port 8888 --target \" http://localhost:8889\" --file" ,
3535 "dev-start-along-mock" : " (export DEBUG=openapi-cop:* || set DEBUG=openapi-cop:*) && npm run compile && node build/test/scripts/spawn" ,
3636 "pretest" : " npm run compile" ,
3737 "test" : " mocha --bail --timeout 60000 --exit build/test/*.test.js" ,
Original file line number Diff line number Diff line change @@ -43,7 +43,6 @@ If you wish to start openapi-cop and a mock server that is based on a different
4343the ` dev-start ` scripts:
4444
4545```` bash
46- # From the base directory
47- npm run dev-start -- some-openapi.yaml # runs on port 8889
48- (cd mock-server && npm run dev-start -- another-openapi.yaml) # runs on port 9000
46+ npm run dev-start -- some-openapi.yaml # listens on port 8888
47+ (cd mock-server && npm run dev-start -- another-openapi.yaml) # listens on port 8889
4948````
You can’t perform that action at this time.
0 commit comments