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

Y24-183 - Move Sequencescape API v1 calls over to API v2 #335

Open
2 tasks
sdjmchattie opened this issue Jul 9, 2024 · 1 comment
Open
2 tasks

Y24-183 - Move Sequencescape API v1 calls over to API v2 #335

sdjmchattie opened this issue Jul 9, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@sdjmchattie
Copy link

sdjmchattie commented Jul 9, 2024

User story

Sequencescape API v1 will be shut down in the near future and has been deprecated for the past 5 years. We should switch usage of the API over to v2, using the already installed json_api_client gem.

Who are the primary contacts for this story

Stuart McHattie

Who is the nominated tester for UAT

PSD

Acceptance criteria

To be considered successful the solution must allow:

  • No more API v1 calls are made to Sequencescape
  • All traces of sequencescape-client-api and its config have been removed.

Dependencies
Any new endpoints required in Sequencescape will have to be created as they are discovered to be missing. A new story should be created under that repository if there are indeed endpoints to create.

Additional context

The calls made during the last two week period are as below, with counts for each endpoint:

  • GET - /api/1/: 17

  • GET - /api/1/plate_purposes: 32

  • GET - /api/1/plate_purposes/2: 16

  • GET - /api/1/plate_purposes/3: 16

  • GET - /api/1/plate_purposes/4: 16

  • GET - /api/1/{uuid}: 17

  • GET - /api/1/{uuid}/wells: 17

  • POST - /api/1/{uuid}/extraction_attributes: 17

  • POST - /api/1/{uuid}/plates: 16

@sdjmchattie sdjmchattie added the enhancement New feature or request label Jul 9, 2024
@sdjmchattie sdjmchattie self-assigned this Jul 9, 2024
@psd-issuer psd-issuer bot changed the title Move Sequencescape API v1 calls over to API v2 Y24-183 - Move Sequencescape API v1 calls over to API v2 Jul 9, 2024
@sdjmchattie
Copy link
Author

Briefly reviewing the code and the list of calls being made to v1, I think we need to start using the PlatePurpose JSON API endpoint that was only created recently. This endpoint might need to be updated to support creating plates and extraction attributes as these are currently not obviously available in SequenceScape. I don't think there are any actual new endpoints to create.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant