Skip to content

Commit 129c883

Browse files
committed
- Added openapi-generator-cli installation steps.
1 parent 677d356 commit 129c883

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,23 +50,35 @@ $ git commit -m "descriptive commit message for your changes"
5050
Models and APIs are auto-generated in accordance with specific openapi spec defined in openapi/management.yaml file.
5151
In order to make changes in models and/or APIs you need to determine what is the root of changes:
5252

53+
### Prerequisites
54+
1. get specific openapi spec version (v7.7.0 in the following example):
55+
```sh
56+
cd openapi
57+
npm install @openapitools/openapi-generator-cli -g
58+
openapi-generator-cli version-manager set 7.7.0
59+
```
60+
5361
### if change is needed because of new version of openapi spec that has been released, then:
5462

5563
1. Make changes to the management.yaml file.
5664
2. Re-generate SDK and verify SDK generation is successfully.
65+
66+
a. Change directory to openapi. `cd openapi`
67+
68+
b. Run the build script to re-generate the Okta SDK Python package:
69+
`generate.sh`
5770
3. Raise the PR mentioning details about the changes made to the management.yaml file.
58-
```sh
59-
yarn build
60-
```
6171

6272
### if change isn't related to new openapi spec version, for example, update template for models, then:
6373

6474
1. edit needed templates under `openapi/templates` directory
6575

6676
2. re-generate okta-sdk-python (in openapi directory):
67-
```sh
68-
yarn build
69-
```
77+
78+
a. Change directory to openapi. `cd openapi`
79+
80+
b. Run the build script to re-generate the Okta SDK Python package:
81+
`generate.sh`
7082

7183
## Adding/Changing Tests
7284

0 commit comments

Comments
 (0)