[IMP] developer/api/external_api: document programmatic API key management#18000
[IMP] developer/api/external_api: document programmatic API key management#18000madprog wants to merge 1 commit into
Conversation
|
|
AntoineVDV
left a comment
AntoineVDV
left a comment
There was a problem hiding this comment.
LGTM! Just a few comments on the structure.
@robodoo delegate+
| - ``key``: an existing valid API key | ||
| - ``scope``: the scope assigned to the new key | ||
| - ``name``: a human-readable label | ||
| - ``expiration_date``: the expiration date of the key |
There was a problem hiding this comment.
add the json datatype of each value, for expiration_data is likely is a ISO8601 encoded string.
| - ``key``: an existing valid API key | |
| - ``scope``: the scope assigned to the new key | |
| - ``name``: a human-readable label | |
| - ``expiration_date``: the expiration date of the key | |
| - ``key`` (string): an existing valid API key | |
| - ``scope`` (string or null): the scope assigned to the new key | |
| - ``name`` (string): a human-readable label | |
| - ``expiration_date`` (string): the expiration date of the key, encoded as a ISO8601datetime |
There was a problem hiding this comment.
alternatively give a (relative) link to the /doc page, anchored on that method. Users will have to change the relative URL to add their domain name, but at least the info is precise.
Talking of which, please improve the docstring of the public methods of res.users.apikeys. At least please document every single parameter via :param.
There was a problem hiding this comment.
The relative link: /doc/res.users.apikeys#generate
Test it: http://localhost:8069/doc/res.users.apikeys#generate
| The expiration date is validated against the maximum API key duration allowed | ||
| by the roles assigned to the user. |
There was a problem hiding this comment.
We should add recommendations about what lifetime we recommend for what usage. Bonus point if those recommendations are based on existing NIST (US)/ENISA (EU) ones.
madprog
force-pushed
the
19.0-apikey_renewal-pmo
branch
from
a13cca0 to
4506f11
Compare
…ement Document the RPC methods introduced by odoo/odoo#246118 to generate and revoke API keys programmatically, and add recommendations about API key rotation best practices.
madprog
force-pushed
the
19.0-apikey_renewal-pmo
branch
from
4506f11 to
48aad54
Compare
4 participants
Document the RPC methods introduced by odoo/odoo#246118 to generate and revoke API keys programmatically, and add recommendations about API key rotation best practices.