diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 327f2d4f4a2..9644a5cb366 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -87,9 +87,7 @@ To add test cases (optional) covering the change in the code generator, please r To test the templates, please perform the following: - Update the Petstore sample by running the shell scripts under the `bin` folder. For example, run `./bin/generate-samples.sh . -/bin/configs/python*` to update the Python-related samples under [`samples`](https://github.com/openapitools/openapi-generator/tree/master/samples). For Windows, please install [GIT bash](https://gitforwindows.org/). (If you find that there are new files g -enerated or unexpected changes as a result of the update, that's not unusual as the test cases are added to the OpenAPI spec fro -m time to time. If you've questions or concerns, please open a ticket to start a discussion) +/bin/configs/python*` to update the Python-related samples under [`samples`](https://github.com/openapitools/openapi-generator/tree/master/samples). For Windows, please install [GIT bash](https://gitforwindows.org/). (If you find that there are new files generated or unexpected changes as a result of the update, that's not unusual as the test cases are added to the OpenAPI spec from time to time. If you've questions or concerns, please open a ticket to start a discussion) - During development it can be helpful to quickly regenerate the samples without recompiling all of openapi-generator, e.g. when you have only updated the mustache templates. This can be done by passing the `-t` parameter: `-t modules/openapi-generator/src/main/resources/python`. - Run the tests in the sample folder using maven `mvn integration-test -f /path/to/pom.xml`, e.g. `mvn integration-test -f samples/client/petstore/python/pom.xml`. (some languages may not contain unit testing for Petstore and we're looking for contribution from the community to implement those tests) - Finally, git commit the updated samples files: `git commit -a` diff --git a/docs/contributing.md b/docs/contributing.md index efadebf3ada..482ffecf4dd 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -91,9 +91,7 @@ To add test cases (optional) covering the change in the code generator, please r To test the templates, please perform the following: - Update the Petstore sample by running the shell scripts under the `bin` folder. For example, run `./bin/generate-samples.sh . -/bin/configs/python*` to update the Python-related samples under [`samples`](https://github.com/openapitools/openapi-generator/tree/master/samples). For Windows, please install [GIT bash](https://gitforwindows.org/). (If you find that there are new files g -enerated or unexpected changes as a result of the update, that's not unusual as the test cases are added to the OpenAPI spec fro -m time to time. If you've questions or concerns, please open a ticket to start a discussion) +/bin/configs/python*` to update the Python-related samples under [`samples`](https://github.com/openapitools/openapi-generator/tree/master/samples). For Windows, please install [GIT bash](https://gitforwindows.org/). (If you find that there are new files generated or unexpected changes as a result of the update, that's not unusual as the test cases are added to the OpenAPI spec from time to time. If you've questions or concerns, please open a ticket to start a discussion) - During development it can be helpful to quickly regenerate the samples without recompiling all of openapi-generator, e.g. when you have only updated the mustache templates. This can be done by passing the `-t` parameter: `-t modules/openapi-generator/src/main/resources/python`. - Run the tests in the sample folder using maven `mvn integration-test -f /path/to/pom.xml`, e.g. `mvn integration-test -f samples/client/petstore/python/pom.xml`. (some languages may not contain unit testing for Petstore and we're looking for contribution from the community to implement those tests) - Finally, git commit the updated samples files: `git commit -a` diff --git a/docs/generators/typescript-rxjs.md b/docs/generators/typescript-rxjs.md index 7bd3cec0bb4..f9cb691160a 100644 --- a/docs/generators/typescript-rxjs.md +++ b/docs/generators/typescript-rxjs.md @@ -129,6 +129,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
  • queryParameters
  • requestOptions
  • return
  • +
  • servers
  • short
  • static
  • super