[ADD] reference/external_json_api #14091
Conversation
|
|
078ad01 to
5230acf
Compare
088509f to
f87ee68
Compare
f87ee68 to
c5c1004
Compare
c5c1004 to
ae75316
Compare
ae75316 to
db1e475
Compare
There was a problem hiding this comment.
I think it would be better to move the RPC-related content to a new file and reuse the very well-referenced external_api.rst file for the new external API instead. Then, in 19.1, the file about deprecated-now-unsupported content can be removed.
This is also because we don't document when this or that feature was added, deprecated, or removed. The documentation for version X.Y documents which features exist in Odoo X.Y, no more no less.
db1e475 to
f09670f
Compare
Done
That we are dropping XML/JSON-RPC is serious enough to mandate the deprecation danger. A common question I've been asked is "is the JSON-2 API available in 18?", hence the "new in 19.0" passage. |
| .. image:: external_api/delete-key.png | ||
| :align: center | ||
|
|
||
| **A deleted API key can not be undeleted or re-set**. You will have to generate |
There was a problem hiding this comment.
A deleted API key cannot be undeleted or re-set
nitpick: A deleted API key cannot be recovered or reset.
| **A deleted API key can not be undeleted or re-set**. You will have to generate | |
| **A deleted API key cannot be recovered or reset**. You will have to generate |
|
|
||
| The ``xmlrpc/2/common`` endpoint provides meta-calls which don't require | ||
| authentication, such as the authentication itself or fetching version | ||
| information. To verify if the connection information is correct before trying |
There was a problem hiding this comment.
nitpick: To verify whether the connection information is correct
| information. To verify if the connection information is correct before trying | |
| information. To verify whether the connection information is correct before trying |
| 78 | ||
| .. warning:: | ||
| While most value types are what would expect (integer for |
There was a problem hiding this comment.
While most value types are what you would expect (integer for
| While most value types are what would expect (integer for | |
| While most value types are what you would expect (integer for |
| :doc:`external_api` acts as replacement. | ||
|
|
||
| Odoo is usually extended internally via modules, but many of its features and | ||
| all of its data are also available from the outside for external analysis or |
There was a problem hiding this comment.
maybe: available externally for analysis or integration
| all of its data are also available from the outside for external analysis or | |
| all of its data are also available externally for analysis or |
| easily available over XML-RPC_ and accessible from a variety of languages. | ||
|
|
||
| Starting with PHP8, the XML-RPC extension may not be available by default. | ||
| Check out the `manual <https://www.php.net/manual/en/xmlrpc.installation.php>`_ |
There was a problem hiding this comment.
nitpick: I would more use something like "Refer to"
| Check out the `manual <https://www.php.net/manual/en/xmlrpc.installation.php>`_ | |
| Refer to the `manual <https://www.php.net/manual/en/xmlrpc.installation.php>`_ |
| authentication itself is done through the ``authenticate`` function and | ||
| returns a user identifier (``uid``) used in authenticated calls instead of |
There was a problem hiding this comment.
real big o nitpick here : which returns instead of and returns to empathize the fact that the function is the one returning the uid
| authentication itself is done through the ``authenticate`` function and | |
| returns a user identifier (``uid``) used in authenticated calls instead of | |
| authentication itself is done through the ``authenticate`` function which | |
| returns a user identifier (``uid``) used in authenticated calls instead of |
f09670f to
b774950
Compare
| to identify the key, and to determine later whether the key is still in use or should be removed. | ||
| The duration determines the lifetime of the key after which the the key becomes invalid. It is | ||
| recommended to set a short duration (typically 1 day) for interactive usage. It is not possible to | ||
| create keys that last for more than 3 months, it means that long lasting keys must be rotated at |
There was a problem hiding this comment.
nitpick months, it means should be months. It means imo
There was a problem hiding this comment.
I don't understand, can you do a ```suggestion instead?
There was a problem hiding this comment.
It's more about the flow here for me it feel like 2 separate sentences
| create keys that last for more than 3 months, it means that long lasting keys must be rotated at | |
| create keys that last for more than 3 months. It means that long lasting keys must be rotated at |
|
|
||
| Conversely, picking only three fields deemed interesting. | ||
| * The minimum required permissions can be granted to the bot, limiting the impact may the API key | ||
| gets compromised; |
There was a problem hiding this comment.
actually not 100% sure on this one
may the API key gets compromised should be if the API key gets compromised
There was a problem hiding this comment.
am not sure either, let's wait a 3rd opinion :)
| ))); | ||
| The following examples showcase how to execute two of the :ref:`reference/orm/models/crud` on a fake | ||
| database ``mycompany`` hosted on a fake website ``https://mycompany.example.com``. Its comprehensive | ||
| documentation would be available at https://mycompany.example.com/doc |
There was a problem hiding this comment.
would be available is a bit speculative and makes it feel like we are not sure imo
There was a problem hiding this comment.
am not sure either, let's wait a 3rd opinion :)
b774950 to
6bfca17
Compare
No description provided.