Project

General

Profile

Actions

Story #15397

open

Declutter the API

Added by Peter Amstutz over 4 years ago. Updated 6 days ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
API
Start date:
Due date:
% Done:

0%

Estimated time:
Story points:
2.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).

  1. Announce deprecation/removal in future version (already done)
  2. 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.
  3. Delete models, controllers, tests, and routes from API server
  4. 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

Related to Arvados - Bug #10346: On the API docs (http://doc.arvados.org/api/), rearrange documentation so metadata features (humans, traits, specimens) do not distract/confuse peopleResolvedPeter Amstutz10/25/2016

Actions
Related to Arvados - Story #15880: Remove hosted git serviceNew

Actions
Related to Arvados Epics - Story #20344: Arvados 3.0New08/01/202308/31/2023

Actions
Related to Arvados - Story #20951: Document deprecated api_client_authorization fieldsResolvedPeter Amstutz

Actions
Related to Arvados - Bug #19929: Improve documentation in the discovery documentNewBrett Smith

Actions
Blocked by Arvados - Support #20840: Update documentation to make it clear certain APIs are deprecatedResolvedPeter Amstutz09/03/2023

Actions
Actions #1

Updated by Peter Amstutz over 4 years ago

  • Status changed from New to In Progress
Actions #2

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
Actions #3

Updated by Peter Amstutz over 4 years ago

  • Description updated (diff)
Actions #4

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
Actions #5

Updated by Peter Amstutz over 4 years ago

  • Description updated (diff)
Actions #6

Updated by Tom Morris about 4 years ago

  • Target version set to To Be Groomed
Actions #7

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
Actions #8

Updated by Peter Amstutz about 2 years ago

  • Target version deleted (Arvados Future Sprints)
Actions #9

Updated by Peter Amstutz 8 months ago

  • Release set to 60
Actions #10

Updated by Peter Amstutz 3 months ago

  • Release deleted (60)
  • Target version set to To be groomed
Actions #11

Updated by Peter Amstutz 3 months ago

  • Description updated (diff)
  • Subject changed from Deprecate & remove human, specimens and traits tables to Declutter the API
Actions #13

Updated by Peter Amstutz 3 months ago

Actions #14

Updated by Peter Amstutz 3 months ago

  • Description updated (diff)
Actions #15

Updated by Peter Amstutz 3 months ago

  • Description updated (diff)
Actions #16

Updated by Peter Amstutz 3 months ago

  • Description updated (diff)
Actions #17

Updated by Peter Amstutz 3 months ago

  • Description updated (diff)
Actions #18

Updated by Peter Amstutz 3 months ago

  • Description updated (diff)
Actions #19

Updated by Peter Amstutz about 2 months ago

Actions #20

Updated by Peter Amstutz about 2 months ago

  • Blocked by Support #20840: Update documentation to make it clear certain APIs are deprecated added
Actions #21

Updated by Brett Smith 20 days ago

  • Related to Story #20951: Document deprecated api_client_authorization fields added
Actions #22

Updated by Peter Amstutz 6 days ago

  • Target version changed from To be groomed to To be scheduled
Actions #23

Updated by Peter Amstutz 6 days ago

  • Target version changed from To be scheduled to Development 2023-11-22 sprint
Actions #24

Updated by Peter Amstutz 6 days ago

  • Related to Bug #19929: Improve documentation in the discovery document added
Actions #25

Updated by Peter Amstutz 6 days ago

  • Target version changed from Development 2023-11-22 sprint to Development 2023-11-08 sprint
Actions #26

Updated by Peter Amstutz 6 days ago

  • Category set to API
  • Subject changed from Declutter the API to Declutter the API
Actions

Also available in: Atom PDF