typesense / typesense/typesense-rust
Generate request/response structs from OpenAPI spec
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 78
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Description
Description
We've a more or less recent Open API spec that was created as part of the Go client implementation here: https://github.com/typesense/typesense-go/blob/master/typesense/api/openapi.yml
I think it would be a good idea to generate the request/response classes/structs using an Open API client generator like Swagger. This would save a lot of time and ensure that we can keep them up-to-date easily across various client implementations.
What do you think @morenol @emmanuelantony2000 ?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing typesense/api/openapi.yml in the typesense-go repository and comparing it with the existing typesense-rust client. Determine which OpenAPI client generator and generated request/response structures would fit the Rust implementation, then define how generated code would be kept up to date across client implementations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, rust
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100