Skip to content

[BLD] Add test for JS client to check for drift in generated openapi spec #4298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 16, 2025

Conversation

jairad26
Copy link
Contributor

@jairad26 jairad26 commented Apr 16, 2025

Description of changes

This PR prettifies the JS client and adds a test in integration tests to ensure that the openapi spec generated code has not differed from the committed version.

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

Copy link

Please tag your PR title with one of: [ENH | BUG | DOC | TST | BLD | PERF | TYP | CLN | CHORE]. See https://docs.trychroma.com/contributing#contributing-code-and-ideas

Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

Copy link
Contributor Author

jairad26 commented Apr 16, 2025

@jairad26 jairad26 changed the title [BUILD] Add test for JS client to check for drift in generated openapi spec [BLD] Add test for JS client to check for drift in generated openapi spec Apr 16, 2025
@jairad26 jairad26 force-pushed the jai/diff-js-test branch 2 times, most recently from b8ebda1 to a983183 Compare April 16, 2025 17:28
@jairad26 jairad26 marked this pull request as ready for review April 16, 2025 17:35
@jairad26 jairad26 enabled auto-merge (squash) April 16, 2025 17:39
@jairad26 jairad26 disabled auto-merge April 16, 2025 17:54
@jairad26 jairad26 enabled auto-merge (squash) April 16, 2025 18:15
@jairad26 jairad26 merged commit 69dc794 into main Apr 16, 2025
69 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