aboutsummaryrefslogtreecommitdiff
path: root/doc/proposals/2022-07-api-renaming.md
blob: dafa98c3d4ef049444d48e8f2a5d08d3b25a092d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# Proposal

Rename the following endpoints:

  - s/get-tree-head-to-cosign/get-untrusted-tree-head/
  - s/get-tree-head-cosigned/get-tree-head/
  - s/get-leaves/get-entries/
  - s/add-leaf/add-entry/

Rename the following ASCII keys:

  - s/start_size/start_index/
  - s/end_size/end_index/

(Reminder: specify zero-based index.)

# Motivation

Improve readability of api.md, especially for those that skim it quickly.  For
example, "untrusted-tree-head" is a very strong signal for what you don't want,
and it should be easier to relate to the term "entry" rather than a "leaf".

The renamed ASCII keys better reflect the text that describes them.