Project

General

Profile

Actions

Bug #22198

closed

Get rid of 'href` in response

Added by Peter Amstutz about 1 month ago. Updated 17 days ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
API
Story points:
-
Release:
Release relationship:
Auto

Description

I observed that several endpoints (users, collections) don't return the documented 'href' field. It seems likely they have not returned this field for a long time (since controller started intercepting these requests), but nobody noticed because nobody relies on it.

On the other hand, some endpoints (workflows, groups) do still return 'href'.

The 'href' field is a synthetic field (not stored in the database) and not very useful because it contains information that can be inferred from the 'uuid' field. (In theory, it could be useful for writing a generic client that doesn't need to understand how the arvados uuid scheme maps to API endpoints, but we've never wanted to do anything like that in practice.)

This was overlooked in the previous cleanup ticket, but the time to make API changes like this is now, before the 3.0 release.

We can save a few bytes if we get rid of this field from the response entirely.


Subtasks 2 (0 open2 closed)

Task #22242: Fix workbench 2ResolvedPeter Amstutz10/24/2024Actions
Task #22243: Review 22198-remove-href-field ResolvedPeter Amstutz10/24/2024Actions

Related issues

Related to Arvados - Feature #15397: Declutter the APIResolvedTom CleggActions
Actions #1

Updated by Peter Amstutz about 1 month ago

  • Status changed from New to In Progress
Actions #2

Updated by Peter Amstutz about 1 month ago

Actions #3

Updated by Peter Amstutz about 1 month ago

  • Description updated (diff)
Actions #4

Updated by Peter Amstutz about 1 month ago

  • Description updated (diff)
Actions #5

Updated by Peter Amstutz about 1 month ago

  • Description updated (diff)
Actions #6

Updated by Peter Amstutz about 1 month ago

  • Status changed from In Progress to New
Actions #7

Updated by Peter Amstutz 29 days ago

  • Release set to 70
Actions #8

Updated by Peter Amstutz 29 days ago

  • Status changed from New to In Progress
Actions #9

Updated by Peter Amstutz 29 days ago

  • Target version changed from Development 2024-10-23 sprint to Development 2024-11-06 sprint
Actions #11

Updated by Peter Amstutz 29 days ago

  • Release deleted (70)
Actions #14

Updated by Peter Amstutz 28 days ago

This LGTM.

It looks like the href field was never documented. It never appeared in the discovery doc (?) or the online API documentation. It was picked up in code because people were working off the actual API responses and not the documented API responses, so I think bringing those in line (in this case by eliminating the undocumented field) is a good improvement.

Actions #15

Updated by Tom Clegg 28 days ago

  • Status changed from In Progress to Resolved
Actions #16

Updated by Peter Amstutz 17 days ago

  • Release set to 70
Actions

Also available in: Atom PDF