Project

General

Profile

Actions

Feature #15397

open

Declutter the API

Added by Peter Amstutz almost 5 years ago. Updated 3 days ago.

Status:
In Progress
Priority:
Normal
Assigned To:
Category:
API
Story points:
3.0
Release:
Release relationship:
Auto

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.

  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.

We are also dropping the hosting git repository support (the "repositories" table). This means we can delete arvados/services/githttpd.

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).

We should remove redundant resource methods from the Discovery Document (the Python and R autogenerated APIs already filter these out, so they are undocumented and nobody should be using them):

  • "show" (synonym for "get")
  • "index" (synonym for "list")
  • "destroy" (synonym for "delete")

There's a "Managed" section under SLURM that has options related to the obsolete slurm-on-cloud configuration.

Another thing to get rid of: support for legacy component-specific config files.

Config options to remove:

Mail.IssueReporterEmailFrom, Mail.IssueReporterEmailTo -- only used by Workbench1 mailers

Mail.EmailFrom -- also only used by Workbench1 mailers

Mail.MailchimpAPIKey, Mail.MailchimpListID -- seem to be tied to a long lost arvados-mailchimp-plugin that we don't use and can't locate

If we delete all of these, the only option left is "SendUserSetupNotificationEmail" which should really migrate to the "Users" section where all the actually-in-use user notification mail options are located.


Subtasks 1 (1 open0 closed)

Task #21683: ReviewNewPeter AmstutzActions

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/2016Actions
Related to Arvados - Idea #15880: Remove hosted git serviceNewActions
Related to Arvados Epics - Idea #20344: Arvados 3.0New08/01/202306/30/2024Actions
Related to Arvados - Idea #20951: Document deprecated api_client_authorization fieldsResolvedPeter AmstutzActions
Related to Arvados - Feature #19929: Improve documentation in the discovery documentNewBrett SmithActions
Related to Arvados - Feature #21226: Fix or remove tests that use deprecated APIsNewTom CleggActions
Related to Arvados - Bug #21416: Document mail-releated configuration optionsResolvedPeter AmstutzActions
Blocked by Arvados - Support #20840: Update documentation to make it clear certain APIs are deprecatedResolvedPeter Amstutz09/03/2023Actions
Blocks Arvados - Feature #21666: provision.sh uses arvados-client diagnostics instead of run-test.shIn ProgressLucas Di PentimaActions
Actions #1

Updated by Peter Amstutz almost 5 years ago

  • Status changed from New to In Progress
Actions #2

Updated by Peter Amstutz almost 5 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 almost 5 years ago

  • Description updated (diff)
Actions #4

Updated by Tom Morris almost 5 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 almost 5 years ago

  • Description updated (diff)
Actions #6

Updated by Tom Morris almost 5 years ago

  • Target version set to To Be Groomed
Actions #7

Updated by Tom Morris over 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 almost 3 years ago

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

Updated by Peter Amstutz about 1 year ago

  • Release set to 60
Actions #10

Updated by Peter Amstutz 10 months ago

  • Release deleted (60)
  • Target version set to Future
Actions #11

Updated by Peter Amstutz 10 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 10 months ago

  • Related to Idea #15880: Remove hosted git service added
Actions #14

Updated by Peter Amstutz 10 months ago

  • Description updated (diff)
Actions #15

Updated by Peter Amstutz 10 months ago

  • Description updated (diff)
Actions #16

Updated by Peter Amstutz 10 months ago

  • Description updated (diff)
Actions #17

Updated by Peter Amstutz 9 months ago

  • Description updated (diff)
Actions #18

Updated by Peter Amstutz 9 months ago

  • Description updated (diff)
Actions #19

Updated by Peter Amstutz 9 months ago

Actions #20

Updated by Peter Amstutz 9 months ago

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

Updated by Brett Smith 7 months ago

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

Updated by Peter Amstutz 7 months ago

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

Updated by Peter Amstutz 7 months ago

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

Updated by Peter Amstutz 7 months ago

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

Updated by Peter Amstutz 7 months ago

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

Updated by Peter Amstutz 7 months ago

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

Updated by Peter Amstutz 6 months ago

  • Target version changed from Development 2023-11-08 sprint to Development 2023-11-29 sprint
Actions #28

Updated by Peter Amstutz 6 months ago

  • Target version changed from Development 2023-11-29 sprint to Future
Actions #29

Updated by Peter Amstutz 6 months ago

  • Target version changed from Future to Development 2024-01-03 sprint
Actions #30

Updated by Peter Amstutz 6 months ago

  • Description updated (diff)
Actions #31

Updated by Peter Amstutz 5 months ago

  • Target version changed from Development 2024-01-03 sprint to Development 2024-01-17 sprint
Actions #32

Updated by Peter Amstutz 5 months ago

  • Target version changed from Development 2024-01-17 sprint to Development 2024-01-03 sprint
Actions #33

Updated by Peter Amstutz 5 months ago

  • Description updated (diff)
Actions #34

Updated by Peter Amstutz 5 months ago

  • Description updated (diff)
Actions #35

Updated by Peter Amstutz 5 months ago

  • Story points changed from 2.0 to 3.0
Actions #36

Updated by Peter Amstutz 5 months ago

  • Related to Feature #21226: Fix or remove tests that use deprecated APIs added
Actions #37

Updated by Peter Amstutz 5 months ago

  • Target version changed from Development 2024-01-03 sprint to Development 2024-01-17 sprint
Actions #38

Updated by Peter Amstutz 4 months ago

  • Target version changed from Development 2024-01-17 sprint to Development 2024-01-31 sprint
Actions #39

Updated by Peter Amstutz 4 months ago

  • Release set to 70
Actions #40

Updated by Peter Amstutz 3 months ago

  • Target version changed from Development 2024-01-31 sprint to Development 2024-02-14 sprint
Actions #41

Updated by Peter Amstutz 3 months ago

  • Target version changed from Development 2024-02-14 sprint to Development 2024-02-28 sprint
Actions #42

Updated by Peter Amstutz 3 months ago

  • Description updated (diff)
Actions #43

Updated by Peter Amstutz 2 months ago

  • Target version changed from Development 2024-02-28 sprint to Development 2024-03-13 sprint
Actions #44

Updated by Peter Amstutz 2 months ago

  • Description updated (diff)
Actions #45

Updated by Peter Amstutz 2 months ago

  • Related to Bug #21416: Document mail-releated configuration options added
Actions #46

Updated by Peter Amstutz about 2 months ago

  • Target version changed from Development 2024-03-13 sprint to Development 2024-03-27 sprint
Actions #47

Updated by Peter Amstutz about 2 months ago

  • Target version changed from Development 2024-03-27 sprint to Development 2024-04-10 sprint
Actions #48

Updated by Peter Amstutz about 2 months ago

  • Tracker changed from Idea to Feature
Actions #51

Updated by Peter Amstutz 27 days ago

  • Target version changed from Development 2024-04-10 sprint to Development 2024-04-24 sprint
Actions #52

Updated by Peter Amstutz 13 days ago

  • Target version changed from Development 2024-04-24 sprint to Development 2024-05-08 sprint
Actions #53

Updated by Peter Amstutz 13 days ago

  • Target version changed from Development 2024-05-08 sprint to Development 2024-04-24 sprint
Actions #54

Updated by Peter Amstutz 12 days ago

  • Assigned To set to Tom Clegg
Actions #55

Updated by Tom Clegg 7 days ago

  • Status changed from New to In Progress
  • Description updated (diff)
Actions #57

Updated by Lucas Di Pentima about 2 hours ago

  • Blocks Feature #21666: provision.sh uses arvados-client diagnostics instead of run-test.sh added
Actions

Also available in: Atom PDF