Skip to content
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

API: Use /records instead of /record for endpoints that affect multiple records #629

Closed
QuantumDancer opened this issue Jan 15, 2024 · 0 comments · Fixed by #632
Closed
Assignees

Comments

@QuantumDancer
Copy link
Collaborator

After implementing #597 I noticed that right now we are a little bit inconsistent with naming the API endpoints (see the docs). The bulk insert uses /records, but querying all or a subset of records still uses /record. We should make this consistent by changing all API endpoints affecting more than one record to /records. Right now these are:

  • query all records (GET /record -> GET /records)
  • query subset of records with a query string (GET /record?<query_string> -> GET /records?<query_string>)

When changing this, we also need to make sure the documentation is up-to-date:

  • Rust client
  • Python client
  • API documentation
  • Migration guide
@QuantumDancer QuantumDancer added this to the Release v0.4.0 milestone Jan 15, 2024
@QuantumDancer QuantumDancer changed the title Use records/ instead of /record for endpoints that affect multiple records Use /records instead of /record for endpoints that affect multiple records Jan 15, 2024
@QuantumDancer QuantumDancer changed the title Use /records instead of /record for endpoints that affect multiple records API: Use /records instead of /record for endpoints that affect multiple records Jan 15, 2024
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 a pull request may close this issue.

2 participants