From 54a6e87334dfb93f01820e65ab08233cb932eb4d Mon Sep 17 00:00:00 2001 From: Rasmus Dahlberg Date: Thu, 21 Jul 2022 15:04:45 +0200 Subject: add renaming proposal --- doc/proposals/2022-07-api-renaming.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 doc/proposals/2022-07-api-renaming.md diff --git a/doc/proposals/2022-07-api-renaming.md b/doc/proposals/2022-07-api-renaming.md new file mode 100644 index 0000000..dafa98c --- /dev/null +++ b/doc/proposals/2022-07-api-renaming.md @@ -0,0 +1,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. -- cgit v1.2.3