Skip to content

Commit 990d886

Browse files
Update readme
1 parent a80fa9e commit 990d886

3 files changed

Lines changed: 21 additions & 1 deletion

File tree

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,31 @@ _NOTE:_ Ensure you have an active Individual Contributor License Agreement (ICLA
7070

7171
For further inquiries, email [help@finos.org](mailto:help@finos.org).
7272

73-
7473
### Updating Generated Code
7574

7675
Python BDK uses [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator/) to generate code.
7776
To update the generated code, follow these steps:
7877

78+
1. Download desired version of openapi generator.
79+
```bash
80+
cd api_client_generation
81+
curl -L https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.14.0/openapi-generator-cli-7.14.0.jar -o openapi-generator-cli.jar
82+
```
83+
2. Adjust the commit for which the code is generated(inside generate.sh script)
84+
3. Execute the generation script:
85+
```bash
86+
./generate.sh
87+
```
88+
4. Commit and push the newly generated code along with the updated JAR file.
89+
90+
Note: There are a few files that are not replaced(EX. api_client.py), those files require some modifications after code is generated.
91+
92+
93+
### OLD Updating Generated Code (Deprecated)
94+
95+
Python BDK uses [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator/) to generate code.
96+
To update the generated code, follow these steps:
97+
7998
1. Checkout the latest branch of the fork (e.g., [sym-python-5.5.0](https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0)).
8099
2. Update the fork source code, review, and merge it.
81100
3. Generate the JAR file in `openapi-generatormodules/openapi-generator-cli/target/openapi-generator-cli.jar`:

api_client_generation/generate.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ generate_files() {
7474
cp *.py "$final_models_dir"
7575

7676
# The rest of the files
77+
# Here we have more files generated that are not updated because they require changes(EX. api_client)
7778
cd "$code_gen_dir/output/symphony/bdk/gen"
7879
cp rest.py "$project_root/symphony/bdk/gen/rest.py"
7980

-24.1 MB
Binary file not shown.

0 commit comments

Comments
 (0)