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

terarium dataservice migration changes #51

Merged
merged 28 commits into from
Feb 1, 2024
Merged

terarium dataservice migration changes #51

merged 28 commits into from
Feb 1, 2024

Conversation

kbirk
Copy link
Contributor

@kbirk kbirk commented Jan 8, 2024

Hello

As you may be aware terarium has inherited the tds datraservice endpoints. Some changes have been made while integrating it with the existing backend.

Here is a small untested branch to assist in transitioning to the new endpoints. The changes are as follows:

  1. Request urls and query params are now kabob-case rather than snake_case.
  2. JSON keys are serialized / deserialized from camelCase rather than snake_case by default. Support for a "X-Enable-Snake-Case" header has been integrated which when provided will serialize / deserialize JSON keys as snake_case.
  3. All id fields are now uuid4 types and will be generated server side. Types have an optional human friendly name field as well.
  4. Our backend uses OAuth2 and many endpoints require a user object for ReBAC. For simplicity we have created a shared service-user that will be injected if the correct basic auth credential is added to each request. I've introduced TDS_USER and TDS_PASSWORD env vars that will be injected in a basic auth header in each request. Please contact our team and we will provide the credential for our staging env. Please do not commit the credential to the repo unencrypted.

Please let me know if there are any issues with this branch or you have any concerns.

Cheers

@mwdchang mwdchang marked this pull request as ready for review February 1, 2024 19:15
@mwdchang mwdchang merged commit 6138fd0 into main Feb 1, 2024
2 checks passed
@mwdchang mwdchang deleted the dataservice-update branch August 15, 2024 16:50
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.

4 participants