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

Compatibility with upcoming version of scicat backend #18

Open
dylanmcreynolds opened this issue May 31, 2022 · 2 comments
Open

Compatibility with upcoming version of scicat backend #18

dylanmcreynolds opened this issue May 31, 2022 · 2 comments

Comments

@dylanmcreynolds
Copy link
Collaborator

dylanmcreynolds commented May 31, 2022

The upcoming backend has different endpoints than the production (loopback) version of backend. Several things known:

- v3 is now v4 (Edit, this is not the case)

  • dataset endpoints no longer have Raw and Derived
@dylanmcreynolds
Copy link
Collaborator Author

Several issues that we might want to take care of at the same time.

There is enough different between the new nest.js backend and the old one that right now, pyscicat will not work with the new version. The major different is that the endpoints have changed. The issues I know about today are that there used to be three sets of we need to decide how to deal with it.

At this point, the new version has one set of dataset endpoints, while the old version has three: Dataset, RawDataset, and DerivedDataset. Currently, pyscicat has three methods that correspond to this.

The version of the api that pyscicat talks to is sent with the URL that the called uses to construct the pyscicat instance.

I propose making changes to pyscicat with the following goals in mind:

  1. Make pyscicat compatible with either v3 or v4.
  2. Match the new backend version's single endpoint mechanism in the pyscicat API.

To do this, I propose:

  1. Add code in the ScicatClient constructor that checks for /v3 or /v4, storing the result in an attribute.
  2. In all three upload methods, swizzle the url appropriately for the correct version of the API.
  3. Deprecate the calls upload_new_dataset and upload_raw_dataset, removing them in a future version.

Adding to this conversaion @nitrosx @abigailalexander

@dylanmcreynolds
Copy link
Collaborator Author

At the developer's meeting, we discussed the future of the version indicator in the URL. It was decided that we would leave it as v3 for now, and at at some future time remove it altogether.

We also discussed the impact of making breaking changes to pyscicat at this point. We would like to simplify a little, removing the multiple calls to data set types.

So we propose to remove the upload_new_dataset and upload_raw_dataset calls from pyscicat.

@nitrosx nitrosx mentioned this issue Jun 16, 2022
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

No branches or pull requests

1 participant