Skip to content

Commit d1a0f70

Browse files
authored
Merge pull request #8654 from swagger-api/update-parser-version
updates parser v1 version
2 parents 0cbcfdd + d8088de commit d1a0f70

File tree

2 files changed

+31
-2
lines changed

2 files changed

+31
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,32 @@ cd /vagrant
156156
- https://hub.docker.com/r/swaggerapi/swagger-codegen-cli-v3/ (official CLI)
157157

158158

159-
##### Swagger Generator Docker Image
159+
##### Swagger Generator Docker Image
160+
161+
The Swagger Generator image provides a ready to use web application (swagger-generator) providing code generation services.
162+
163+
Image accepts the following env variables:
164+
JAVA_MEM e.g. 1024m
165+
166+
- `HTTP_PORT` e.g. `8080`
167+
- `HIDDEN_OPTIONS_PATH` (alternative to `HIDDEN_OPTIONS`): useful if attaching a volume containing a `hiddenOptions.yaml` file definining which languages to hide. e.g. `/data/hiddenOptions.yaml`
168+
- `HIDDEN_OPTIONS` (alternative to `HIDDEN_OPTIONS_PATH`): allows to pass hidden options as an env variable, in the format `{category}:{language},{language},{language}|{category}:{language},{language},{language}`
169+
e.g. `servers:foo,bar|clientsV3:wtf,isthis` where category can be `clients`, `servers`, `clientsV3`, `serversV3`
170+
171+
An example of running the container:
172+
173+
`docker pull swaggerapi/swagger-generator-v3`
174+
175+
`docker run -e "HIDDEN_OPTIONS=servers:foo,bar|clientsV3:fgf,sdsd" -e "JAVA_MEM=1024m" -e "HTTP_PORT=80" -p 80:80 --name swagger-generator-v3 swaggerapi/swagger-generator-v3`
176+
177+
or
178+
179+
`docker run -e "HIDDEN_OPTIONS_PATH=/hiddenOptions.yaml" -e "JAVA_MEM=1024m" -e "HTTP_PORT=80" -p 80:80 --name swagger-generator-v3 swaggerapi/swagger-generator-v3`
180+
181+
##### Swagger Generator "Minimal" Docker Image
182+
183+
The Swagger Generator "Minimal" image can act as a self-hosted web application and API for generating code.
160184

161-
The Swagger Generator image can act as a self-hosted web application and API for generating code.
162185
This container can be incorporated into a CI pipeline, and requires some docker orchestration to access generated code.
163186

164187
Example usage:

modules/swagger-generator/pom.xml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,11 @@
289289
</profile>
290290
</profiles>
291291
<dependencies>
292+
<dependency>
293+
<groupId>io.swagger</groupId>
294+
<artifactId>swagger-parser</artifactId>
295+
<version>${swagger-parser-version-v1}</version>
296+
</dependency>
292297
<dependency>
293298
<groupId>javax.servlet</groupId>
294299
<artifactId>javax.servlet-api</artifactId>
@@ -324,6 +329,7 @@
324329
<properties>
325330
<dockerfile.tag.skip>true</dockerfile.tag.skip>
326331
<docker-latest-tag>unstable</docker-latest-tag>
332+
<swagger-parser-version-v1>1.0.38-SNAPSHOT</swagger-parser-version-v1>
327333
<maven-plugin-version>1.0.0</maven-plugin-version>
328334
<jetty-version>9.4.11.v20180605</jetty-version>
329335
<inflector-version>2.0.0-rc2</inflector-version>

0 commit comments

Comments
 (0)