python-tuf/docs
Martin Vrachev 28b6917739 Root and Targets key API changes
Here is the list of all breaking API changes:
1) The "role" and "key" arguments in "Root.add_key()" are in reverse
order - "key" becomes first and "role" second.
2) "Root.remove_key()" has been renamed to "Root.revoke_key()".
3) The "role" and "keyid" arguments in "Root.revoke_key()" are in
reverse order - "keyid" becomes first and "role" second.
4) The "role" and "key" arguments in "Targets.add_key()" are in reverse
order - "key" becomes first and "role" second.
5) "Targets.remove_key()" has been renamed to "Targets.revoke_key()".
6) The "role" and "keyid" arguments in "Targets.revoke_key()" are in
reverse order - "keyid" becomes first and "role" second.
7) In both methods "Targets.add_key()" and "Targets.revoke_key()" the
"role" argument becomes an optional with a default value of None.

Those changes are made in an effort to make those methods logical
for both cases when standard roles and succinct_roles are used.
The "Root" API change was done in order to preserve naming and argument
order consistency with "Targets" API.

Signed-off-by: Martin Vrachev <mvrachev@vmware.com>
2022-06-17 13:33:01 +03:00
..
_posts blog: Update post date, update sloccount 2022-05-04 09:53:46 +03:00
adr Include the design doc in repo 2021-12-01 10:32:46 +02:00
api Fixes #1916 2022-05-17 09:40:16 +05:30
1.0.0-ANNOUNCEMENT.md doc: reword announcement about upcoming 1.0.0 2022-02-18 15:23:37 +02:00
_config.yml docs: Clean up blog header 2022-02-28 12:01:06 +02:00
CHANGELOG.md python-tuf 1.1.0 2022-04-27 16:03:07 +03:00
CODE-OF-CONDUCT.md Move docs to the docs/ directory 2018-01-24 10:57:01 -05:00
conf.py docs: Add a new 200px icon 2022-02-25 10:54:08 +02:00
CONTRIBUTING.rst doc: cross-doc absolute link hack 2022-02-10 10:10:20 +01:00
GOVERNANCE.md doc: rename contribution instructions 2022-02-09 15:08:45 +01:00
index.md docs: Add blog configuration 2022-02-24 16:07:18 +02:00
index.rst doc: minor title changes for rtd navbar 2022-02-09 17:56:35 +01:00
INSTALLATION.rst doc: move verify section in install docs 2022-02-10 10:07:13 +01:00
MAINTAINERS.txt doc: add emeritus section to maintainers file 2022-02-11 09:49:33 +01:00
RELEASE.md Merge pull request #1979 from lukpueh/verify_release-sign 2022-04-27 14:32:07 +03:00
repository-library-design-ownership.jpg Include the design doc in repo 2021-12-01 10:32:46 +02:00
repository-library-design-usage.jpg Include the design doc in repo 2021-12-01 10:32:46 +02:00
repository-library-design.md Root and Targets key API changes 2022-06-17 13:33:01 +03:00
tuf-horizontal-white.png doc: render tuf logo and favicon on rtd 2022-02-07 12:47:44 +01:00
tuf-icon-32.png docs: Add a new 200px icon 2022-02-25 10:54:08 +02:00
tuf-icon-200.png docs: Add a new 200px icon 2022-02-25 10:54:08 +02:00