lbryio / lbryio/lbry-sdk

Standardize `name` vs `claim_name` across APIs

Open
#1,159 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

area: jsonrpc level: 1 type: improvement
Dominant language
Python
Stars
7.2k
Forks
493
PR merge metrics
No merged PRs in 30d

Description

Currently, there are discrepancies between with the naming of the "claim name".

When calling `file_list` this name is returned as `claim_name`
When calling `claim_list_xxx` it is returned as `name`

This should be standardized as just `claim_name`, to avoid confusion.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the implementations of the file_list and claim_list_xxx APIs and compare how each names the claim field in its response. Standardize the differing response name to claim_name across these APIs and verify that the returned fields are consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.