Skip to content

[ENH]: Get/Delete collection name validation + Get collection by ID #4381

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

tazarov
Copy link
Contributor

@tazarov tazarov commented Apr 25, 2025

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • Get and Delete collection now validate collection name
    • Get collection now allows getting a collection with a collection UUID

Test plan

How are these changes tested?

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

Documentation Changes

Copy link
Contributor Author

tazarov commented Apr 25, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

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

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

@tazarov tazarov changed the title feat: Get/Delete collection name validation + Get collection by ID [ENH]: Get/Delete collection name validation + Get collection by ID Apr 25, 2025
Copy link
Contributor

Collection Name Validation for Get/Delete + Get Collection by ID

This PR introduces stricter validation for collection names when using the Get and Delete collection endpoints, ensuring they conform to defined naming rules (alphanumeric, length, and character constraints). Additionally, the Get Collection endpoint is enhanced to accept either a collection name or a collection UUID. Comprehensive backend Rust and generated TypeScript client changes are included, with new and expanded tests to validate both the functional and error cases.

Key Changes:
• Added custom name validation to Get and Delete collection requests in Rust API types.
• Get Collection endpoint now accepts either a collection name or UUID via unified collection_id_or_name parameter.
• Server-side logic updated to recognize and handle both types of identifiers.
• Validation error messages improved for clarity.
• Integration and unit tests added for valid/invalid collection names and UUIDs in Get and Delete flows.
• Generated JS client updated to match new API shape and parameter names.

Affected Areas:
• Rust API endpoints (get_collection, delete_collection)
• Name validation logic (validators.rs)
• System database client and frontend implementation
• OpenAPI annotations and TypeScript JS client-generation
• Test suites for collection operations

This summary was automatically generated by @propel-code-bot

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.

1 participant