Skip to content

Commit 2dba57f

Browse files
authored
chore: md file changes (#705)
<!-- We appreciate the effort for this pull request but before that please make sure you read the contribution guidelines, then fill out the blanks below. Please format the PR title appropriately based on the type of change: <type>[!]: <description> Where <type> is one of: docs, chore, feat, fix, test, misc. Add a '!' after the type for breaking changes (e.g. feat!: new breaking feature). **All third-party contributors acknowledge that any contributions they provide will be made under the same open-source license that the open-source project is provided under.** Please enter each Issue number you are resolving in your PR after one of the following words [Fixes, Closes, Resolves]. This will auto-link these issues and close them when this PR is merged! e.g. Fixes #1 Closes #2 --> # Fixes # A short description of what this PR does. ### Checklist - [x] I acknowledge that all my contributions will be made under the project's license - [ ] Run `make test-docker` - [ ] Verify affected language: - [ ] Generate [twilio-go](https://github.com/twilio/twilio-go) from our [OpenAPI specification](https://github.com/twilio/twilio-oai) using the [build_twilio_go.py](./examples/build_twilio_go.py) using `python examples/build_twilio_go.py path/to/twilio-oai/spec/yaml path/to/twilio-go` and inspect the diff - [ ] Run `make test` in `twilio-go` - [ ] Create a pull request in `twilio-go` - [ ] Provide a link below to the pull request - [ ] I have made a material change to the repo (functionality, testing, spelling, grammar) - [ ] I have read the [Contribution Guidelines](https://github.com/twilio/twilio-oai-generator/blob/main/CONTRIBUTING.md) and my PR follows them - [ ] I have titled the PR appropriately - [ ] I have updated my branch with the main branch - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have added the necessary documentation about the functionality in the appropriate .md file - [ ] I have added inline documentation to the code I modified If you have questions, please create a GitHub Issue in this repository.
1 parent 6b4f5a5 commit 2dba57f

File tree

2 files changed

+9
-12
lines changed

2 files changed

+9
-12
lines changed

PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ A short description of what this PR does.
2121
### Checklist
2222
- [x] I acknowledge that all my contributions will be made under the project's license
2323
- [ ] Run `make test-docker`
24-
- [ ] Verify affected language:
25-
- [ ] Generate [twilio-go](https://github.com/twilio/twilio-go) from our [OpenAPI specification](https://github.com/twilio/twilio-oai) using the [build_twilio_go.py](./examples/build_twilio_go.py) using `python examples/build_twilio_go.py path/to/twilio-oai/spec/yaml path/to/twilio-go` and inspect the diff
26-
- [ ] Run `make test` in `twilio-go`
27-
- [ ] Create a pull request in `twilio-go`
28-
- [ ] Provide a link below to the pull request
24+
- [ ] Verify affected language according to the code change:
25+
- [ ] Generate [twilio-java](https://github.com/twilio/twilio-java) from our [OpenAPI specification](https://github.com/twilio/twilio-oai) using the [scripts/build_twilio_library.py](./scripts/build_twilio_library.py) using `python scripts/build_twilio_library.py path/to/twilio-oai/spec/yaml path/to/twilio-java -l java` and inspect the diff
26+
- [ ] Run `make test` in `twilio-java`
27+
- [ ] Create a pull request in `twilio-java`
28+
- [ ] Provide a link below to the pull request, this ensures that the generated code has been verified
2929
- [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
3030
- [ ] I have read the [Contribution Guidelines](https://github.com/twilio/twilio-oai-generator/blob/main/CONTRIBUTING.md) and my PR follows them
3131
- [ ] I have titled the PR appropriately

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,6 @@ java -cp /path/to/openapi-generator-cli.jar:/path/to/your.jar org.openapitools.c
5656

5757
(Do not forget to replace the values `/path/to/openapi-generator-cli.jar`, `/path/to/your.jar` and `/path/to/openapi.yaml` in the previous command)
5858

59-
Here is an example script to generate [twilio-go](https://github.com/twilio/twilio-go) from our [OpenAPI specification](https://github.com/twilio/twilio-oai): [build_twilio_go.py](./examples/build_twilio_go.py).
60-
6159
### For Windows
6260
You will need to use `;` instead of `:` in the classpath, e.g.
6361
```
@@ -109,8 +107,8 @@ To generate [`twilio-go`](https://github.com/twilio/twilio-go) from [`twilio-oai
109107

110108
Update `<path to>` and execute the following from the root of this repo:
111109

112-
* To generate the entire suite, run `make install && python3 examples/build_twilio_go.py <path to>/twilio-oai/spec/yaml <path to>/twilio-go`
113-
* To generate the provider for a single domain such as studio, run `make install && python3 examples/build_twilio_go.py <path to>/twilio-oai/spec/yaml/twilio_studio_v2.yaml <path to>/twilio-go`
110+
* To generate the entire suite, run `make install && python3 scripts/build_twilio_library.py <path to>/twilio-oai/spec/yaml <path to>/twilio-go`
111+
* To generate the provider for a single domain such as studio, run `make install && python3 scripts/build_twilio_library.py <path to>/twilio-oai/spec/yaml/twilio_studio_v2.yaml <path to>/twilio-go`
114112

115113
## Generating terraform-provider-twilio
116114

@@ -125,6 +123,5 @@ Update `<path to>` and execute the following from the root of this repo:
125123

126124
Update `<path to>` and execute the following from the root of this repo:
127125

128-
* To generate the entire suite, run `make install && python3 examples/build_twilio_go.py <path to>/twilio-oai/spec/yaml <path to>/terraform-provider-twilio -l terraform`
129-
* To generate the provider for a single domain such as studio, run `make install && python3 examples/build_twilio_go.py <path to>/twilio-oai/spec/yaml/twilio_studio_v2.yaml <path to>/terraform-provider-twilio -l terraform`
130-
* Run `python3 examples/build_twilio_go.py -h` to see more details
126+
* To generate the entire suite, run `make install && python3 scripts/build_twilio_library.py <path to oai spec file>/twilio-oai/spec/yaml/abc.yaml <path to language repo>/github/twilio/twilio-java/<language> -l java`
127+
* Run ` python3 scripts/build_twilio_library.py -h` to see more details

0 commit comments

Comments
 (0)