Story #15397
openDeclutter the API
0%
Description
There are several legacy tables "humans" "specimens" and "traits". These were added extremely early on with the best intentions of supporting the PGP use case but as far as I know they have never used for their intended purpose. They should be deprecated and removed to de-clutter the API.
We are also dropping the hosting git repository support (the "repositories" table).
We would also like to remove and stop publishing anything related to the jobs API, e.g. "jobs" and "job_tasks", "pipeline_instances", "pipeline_templates", "nodes".
We should also get rid of the "keep_disks" table.
We should remove some unused fields from "api_client_authorization" response: default_owner_uuid
, api_client_id
, user_id
(the _id
fields may need to remain internally but should not be published by the API because they are not usable with any other API calls).
- Announce deprecation/removal in future version (already done)
- A few integration tests use these APIs because they are generic resources with no business logic. These tests need to be updated to use a different resource or otherwise perform test a different way.
- Delete models, controllers, tests, and routes from API server
- Delete from documentation
These should not appear in the discovery document or the auto-generated python docs. The auto-generated SDKs (e.g. the R SDK) should also be updated.
Related issues
Updated by Peter Amstutz over 4 years ago
- Status changed from New to In Progress
Updated by Peter Amstutz over 4 years ago
- Subject changed from Deprecate human/sample/specimen tables to Deprecate & remove human, specimens and traits tables
- Description updated (diff)
- Status changed from In Progress to New
Updated by Tom Morris over 4 years ago
- Related to Bug #10346: On the API docs (http://doc.arvados.org/api/), rearrange documentation so metadata features (humans, traits, specimens) do not distract/confuse people added
Updated by Tom Morris about 4 years ago
- Target version changed from To Be Groomed to Arvados Future Sprints
- Story points set to 2.0
Updated by Peter Amstutz about 2 years ago
- Target version deleted (
Arvados Future Sprints)
Updated by Peter Amstutz 3 months ago
- Release deleted (
60) - Target version set to To be groomed
Updated by Peter Amstutz 3 months ago
- Description updated (diff)
- Subject changed from Deprecate & remove human, specimens and traits tables to Declutter the API
Updated by Peter Amstutz 3 months ago
- Related to Story #15880: Remove hosted git service added
Updated by Peter Amstutz about 2 months ago
- Related to Story #20344: Arvados 3.0 added
Updated by Peter Amstutz about 2 months ago
- Blocked by Support #20840: Update documentation to make it clear certain APIs are deprecated added
Updated by Brett Smith 20 days ago
- Related to Story #20951: Document deprecated api_client_authorization fields added
Updated by Peter Amstutz 6 days ago
- Target version changed from To be groomed to To be scheduled
Updated by Peter Amstutz 6 days ago
- Target version changed from To be scheduled to Development 2023-11-22 sprint
Updated by Peter Amstutz 6 days ago
- Related to Bug #19929: Improve documentation in the discovery document added
Updated by Peter Amstutz 6 days ago
- Target version changed from Development 2023-11-22 sprint to Development 2023-11-08 sprint
Updated by Peter Amstutz 6 days ago
- Category set to API
- Subject changed from Declutter the API to Declutter the API