hashicorp / hashicorp/python-tfe
Code generate the python client using the publicly accessible OpenAPI spec
- Dominant language
- Python
- Stars
- 17
- Forks
- 11
- Avg merge
- 2d 27m
- Merged PRs (30d)
- 4
Description
[https://app.terraform.io/openapi/prerelease.json](https://app.terraform.io/openapi/prerelease.json)
#### Use-cases
Avoid the delay in uptake and maintenance burden as new endpoints, operations, attributes, and relationships as they are added to the platform API.
#### Proposal
- Use any number of SDK generation tools to regularly code generate the API code published to HCP Terraform (link above). We use Microsoft Kiota for generating [go-tfe/v2](https://github.com/hashicorp/go-tfe).
- Maintain just the wrapper, middleware, authentication, and other cross-cutting functionality, allowing the API to be extended automatically.
Contributor guide
Research direction
Start with the public prerelease OpenAPI spec at https://app.terraform.io/openapi/prerelease.json and compare the current python-tfe client structure with the referenced go-tfe/v2 Kiota approach. Identify the wrapper, middleware, authentication, and other cross-cutting areas that must remain maintained manually. Done means the client can be regularly generated from the published spec while preserving those manually maintained layers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100