Go Config options:
- packageName: Go package name (convention: lowercase). (Default: openapi)
- packageVersion: Go package version. (Default: 1.0.0)
- hideGenerationTimestamp: Hides the generation timestamp when files are generated. (Default: true)
- isGoSubmodule: whether the generated Go module is a submodule (Default: false)
- withGoCodegenComment: whether to include Go codegen comment to disable Go Lint and collapse by default GitHub in PRs and diffs (Default: false)
- withXml: whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false)
- enumClassPrefix: Prefix enum with class name (Default: false)
- structPrefix: whether to prefix struct with the class name. e.g. DeletePetOpts => PetApiDeletePetOpts (Default: false)
- withAWSV4Signature: whether to include AWS v4 signature support (Default: false)
- prependFormOrBodyParameters: Add form or body parameters to the beginning of the parameter list. (Default: false)
Python Config options:
- packageName: python package name (convention: snake_case). (Default: openapi_client)
- projectName: python project name in setup.py (e.g. petstore-api).
- packageVersion: python package version. (Default: 1.0.0)
- packageUrl: python package URL.
- sortParamsByRequiredFlag: Sort method arguments to place required parameters before optional parameters. (Default: true)
- hideGenerationTimestamp: Hides the generation timestamp when files are generated. (Default: true)
- generateSourceCodeOnly: Specifies that only a library source code is to be generated. (Default: false)
- useNose: use the nose test framework (Default: false)
- library: library template (sub-template) to use: asyncio, tornado, urllib3 (Default: urllib3)
What you will need:
-
Your github user email and name to setup git to use those when creating the branch for PR.
-
A personal github token, to access the github token, that will allow to create a Pull Request.
Variables to be set:
export GITHUB_TOKEN="[HERE_YOUR_GENERATED_TOKEN]"
export GITHUB_USER_EMAIL="[email protected]" \
export GITHUB_USER_NAME="David Hontecillas" \
export V1SWAGGER="/data/swagger.v1.yaml"
export V2SWAGGER="/data/swagger.v2.yaml"
export V3SWAGGER="/data/swagger.v3.yaml"
export PMSWAGGER="/data/swagger.pm.yaml"
Pull the docker image with: docker pull dhontecillas/teamworkapigenpr:v0.1
Or build the docker image from local source with: make builddockerupdater
Use the docker image to update once you have your env vars set:
make runupdater