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

Collection and Dataset versions using the swagger interface #7412

Open
adeslatt opened this issue Jan 20, 2025 · 0 comments
Open

Collection and Dataset versions using the swagger interface #7412

adeslatt opened this issue Jan 20, 2025 · 0 comments
Labels
bug Someone made a missteak...

Comments

@adeslatt
Copy link

Describe the bug

Submitters submit multiple versions of their datasets. When one wants to retrieve collection versions and dataset versions through the swagger interface. I was not able to get the collection version ids, but it could be that it does not exist. The collection_id I which I assume is the UUID, I get a 403 error. I learned this by getting the dataset version ids. Retrieving the dataset versions for a particular collection, we see that the collection_id used in the swagger command to retrieve the versions is the correct one as it is the same for all the dataset versions.

To Reproduce

To reproduce the error I used to retrieve the collection versions -- I used the swagger interface - this was done with the try it now button.

the collection version id is 6f6d381a-7701-4781-935c-db10d30de293 for the publication by Sikkema, et. al 2023 Nat Med

Image

This returns a 404 error stating the resource is not found
Image

However, when one dives into the dataset version ids we see the following:

Image

We do get a response that we can dive into. We sleuth out that the most efficient way to get all the dataset versions is to search for citations we can see all the collection_ids, collection_version_ids, dataset_ids, is to search for citation doing so and stepping through you see there are 7 citations. I have grabbed the relevant sections here from the returned json results.

Swagger Call Citation Block
GET /v1/datasets/066943a2-fdac-4b29-b348-40cede398e4e/versions "collection_version_id": "05e5e8d5-26bb-42d6-82df-d734e1663024"
"dataset_id": "066943a2-fdac-4b29-b348-40cede398e4e"
"dataset_version_id": "b351804c-293e-4aeb-9c4c-043db67f4540"
"collection_id": "6f6d381a-7701-4781-935c-db10d30de293"
"collection_version_id": "4fa801d9-94f3-47ff-869f-41bb672bd125"
"dataset_id": "066943a2-fdac-4b29-b348-40cede398e4e"
"dataset_version_id": "2aa90e63-9a6d-444d-8343-8fc2a9921797"
"collection_id": "6f6d381a-7701-4781-935c-db10d30de293"
"collection_version_id": "a759c536-7f21-4ffb-a879-8767bbe858c8"
"dataset_id": "066943a2-fdac-4b29-b348-40cede398e4e"
"dataset_version_id": "c0147bc9-356c-462c-93b9-8d0921887304"
"collection_id": "6f6d381a-7701-4781-935c-db10d30de293"
"collection_version_id": "1e33a4fb-92bf-40c0-b78b-075b5e51783d"
"dataset_id": "066943a2-fdac-4b29-b348-40cede398e4e"
"dataset_version_id": "7a3f08f9-5d07-4ddd-a8fe-5967dd34f35f"
this last one is a place holder or otherwise likely bogus entry "collection_id": "fedcba98-7654-3210-fedc-ba9876543210"
"collection_version_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
"dataset_id": "01234567-89ab-cdef-0123-456789abcdef"
"dataset_version_id": "01234567-89ab-cdef-0123-456789abcdef

what we see here is UUID for the collection_id is 6f6d381a-7701-4781-935c-db10d30de293 and the UUID for the dataset_id is 066943a2-fdac-4b29-b348-40cede398e4e as they are unchanged in every entry, except the last where the likely entry is a place holder at least for the dataset_version_id since it is of the form 01234567-89ab-cdef-0123-456789abcdef.

And now we have the following for collection_version_ids and dataset_version_ids

Number collection_id (UUID) collection_version_id
1 6f6d381a-7701-4781-935c-db10d30de293 4fa801d9-94f3-47ff-869f-41bb672bd125
2 6f6d381a-7701-4781-935c-db10d30de293 a759c536-7f21-4ffb-a879-8767bbe858c8
3 6f6d381a-7701-4781-935c-db10d30de293 e33a4fb-92bf-40c0-b78b-075b5e51783d
Number dataset_id (UUID) dataset_version_id
1 066943a2-fdac-4b29-b348-40cede398e4e 2aa90e63-9a6d-444d-8343-8fc2a9921797
2 066943a2-fdac-4b29-b348-40cede398e4e c0147bc9-356c-462c-93b9-8d0921887304
3 066943a2-fdac-4b29-b348-40cede398e4e 1e33a4fb-92bf-40c0-b78b-075b5e51783d

Now this may be used to retrieve specific versions of the collections and the datasets

Expected behavior

I would have expected the swagger interface for returning the collection_version_ids to have worked and returned what I retrieved successfully and sleuthed out from the call to the getting the dataset version ids

Environment

Provide a description of your system and the software versions.

This was done within the following environment

  • Chrome browser
  • Version 131.0.6778.265 (Official Build) (arm64)
  • MacBook Pro
  • Chip: Apple M3 Pro
  • Sonoma 14.6
@adeslatt adeslatt added the bug Someone made a missteak... label Jan 20, 2025
@ebezzi ebezzi transferred this issue from chanzuckerberg/cellxgene-census Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Someone made a missteak...
Projects
None yet
Development

No branches or pull requests

1 participant