File tree 1 file changed +10
-4
lines changed
1 file changed +10
-4
lines changed Original file line number Diff line number Diff line change @@ -28,14 +28,18 @@ Available on [Maven Central](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%2
28
28
29
29
# Docker
30
30
31
- Available on [ Docker Hub] ( https://hub.docker.com/r/quen2404/openapi-diff/ )
31
+ Available on [ Docker Hub] ( https://hub.docker.com/r/quen2404/openapi-diff/ ) as ` quen2404/openapi-diff ` .
32
32
33
- ## Build image
33
+ ## Build the image
34
+
35
+ This is only required if you want to try new changes in the Dockerfile of this project.
34
36
35
37
``` bash
36
- docker build -t openapi-diff .
38
+ docker build -t local- openapi-diff .
37
39
```
38
40
41
+ You can replace the local image name ` local-openapi-diff ` by any name of your choice.
42
+
39
43
## Run an instance
40
44
41
45
In this example the ` $(pwd)/src/test/resources ` directory is mounted in the ` /specs ` directory of the container
@@ -44,9 +48,11 @@ in readonly mode (`ro`).
44
48
``` bash
45
49
docker run -t \
46
50
-v $( pwd) /src/test/resources:/specs:ro \
47
- openapi-diff /specs/path_1.yaml /specs/path_2.yaml
51
+ quen2404/ openapi-diff /specs/path_1.yaml /specs/path_2.yaml
48
52
```
49
53
54
+ The remote name ` quen2404/openapi-diff ` can be replaced with ` local-openapi-diff ` or the name you gave to your local image.
55
+
50
56
# Usage
51
57
OpenDiff can read swagger api spec from json file or http.
52
58
You can’t perform that action at this time.
0 commit comments