Skip to content

Conversation

haydenhoang
Copy link
Contributor

Change Summary

cargo xtask fetch will fetch the api spec from this repository and overwrite the openapi.yml.

cargo xtask code-gen will preprocess the openapi.yml and write it to preprocessed_openapi.yml then run the codegen via Docker.

As to why we need to preprocess the open api spec file: some of the URL parameters are defined as object type (SearchParameters, MultisearchParameters,...) which are invalid. The preprocess step basically flatten the object into individual URL parameters.

Also added compose.yml to start a typesense server locally for future testing.

PR Checklist

…pi spec

Also added `compose.yml` to start a typesense server locally for testing
@haydenhoang
Copy link
Contributor Author

Hi @morenol, for context: #47

For easier review, this is a split PR of #47, the next PR will add the multi-node client.

Copy link
Collaborator

@morenol morenol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just small nit not sure if this should be run on CI and create a PR on intervals?

@haydenhoang
Copy link
Contributor Author

The tests should pass now.

just small nit not sure if this should be run on CI and create a PR on intervals?

Could be, but for now let's just run it manually.

@morenol morenol merged commit 1a73208 into typesense:main Aug 27, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants