Feature #15397
openDeclutter the API
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.
- 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.
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.
Related issues
Updated by Peter Amstutz almost 5 years ago
- Status changed from New to In Progress
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
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
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
Updated by Peter Amstutz almost 3 years ago
- Target version deleted (
Arvados Future Sprints)
Updated by Peter Amstutz 10 months ago
- Release deleted (
60) - Target version set to Future
Updated by Peter Amstutz 10 months ago
- Description updated (diff)
- Subject changed from Deprecate & remove human, specimens and traits tables to Declutter the API
Updated by Peter Amstutz 10 months ago
- Related to Idea #15880: Remove hosted git service added
Updated by Peter Amstutz 9 months ago
- Related to Idea #20344: Arvados 3.0 added
Updated by Peter Amstutz 9 months ago
- Blocked by Support #20840: Update documentation to make it clear certain APIs are deprecated added
Updated by Brett Smith 8 months ago
- Related to Idea #20951: Document deprecated api_client_authorization fields added
Updated by Peter Amstutz 7 months ago
- Target version changed from Future to To be scheduled
Updated by Peter Amstutz 7 months ago
- Target version changed from To be scheduled to Development 2023-11-29 sprint
Updated by Peter Amstutz 7 months ago
- Related to Feature #19929: Improve documentation in the discovery document added
Updated by Peter Amstutz 7 months ago
- Target version changed from Development 2023-11-29 sprint to Development 2023-11-08 sprint
Updated by Peter Amstutz 7 months ago
- Category set to API
- Subject changed from Declutter the API to Declutter the API
Updated by Peter Amstutz 6 months ago
- Target version changed from Development 2023-11-08 sprint to Development 2023-11-29 sprint
Updated by Peter Amstutz 6 months ago
- Target version changed from Development 2023-11-29 sprint to Future
Updated by Peter Amstutz 6 months ago
- Target version changed from Future to Development 2024-01-03 sprint
Updated by Peter Amstutz 5 months ago
- Target version changed from Development 2024-01-03 sprint to Development 2024-01-17 sprint
Updated by Peter Amstutz 5 months ago
- Target version changed from Development 2024-01-17 sprint to Development 2024-01-03 sprint
Updated by Peter Amstutz 5 months ago
- Related to Feature #21226: Fix or remove tests that use deprecated APIs added
Updated by Peter Amstutz 5 months ago
- Target version changed from Development 2024-01-03 sprint to Development 2024-01-17 sprint
Updated by Peter Amstutz 5 months ago
- Target version changed from Development 2024-01-17 sprint to Development 2024-01-31 sprint
Updated by Peter Amstutz 3 months ago
- Target version changed from Development 2024-01-31 sprint to Development 2024-02-14 sprint
Updated by Peter Amstutz 3 months ago
- Target version changed from Development 2024-02-14 sprint to Development 2024-02-28 sprint
Updated by Peter Amstutz 3 months ago
- Target version changed from Development 2024-02-28 sprint to Development 2024-03-13 sprint
Updated by Peter Amstutz 2 months ago
- Related to Bug #21416: Document mail-releated configuration options added
Updated by Peter Amstutz 2 months ago
- Target version changed from Development 2024-03-13 sprint to Development 2024-03-27 sprint
Updated by Peter Amstutz about 2 months ago
- Target version changed from Development 2024-03-27 sprint to Development 2024-04-10 sprint
Updated by Peter Amstutz about 2 months ago
- Tracker changed from Idea to Feature
Updated by Peter Amstutz about 1 month ago
- Target version changed from Development 2024-04-10 sprint to Development 2024-04-24 sprint
Updated by Peter Amstutz 21 days ago
- Target version changed from Development 2024-04-24 sprint to Development 2024-05-08 sprint
Updated by Peter Amstutz 21 days ago
- Target version changed from Development 2024-05-08 sprint to Development 2024-04-24 sprint
Updated by Tom Clegg 11 days ago
15397-remove-obsolete-apis @ b7103b6069c2c04a9719036e54781231821bb2fc -- developer-run-tests: #4190
Updated by Lucas Di Pentima 8 days ago
- Blocks Feature #21666: provision.sh uses arvados-client diagnostics instead of run-test.sh added
Updated by Peter Amstutz 6 days ago
- Target version changed from Development 2024-04-24 sprint to Development 2024-05-08 sprint