-
Notifications
You must be signed in to change notification settings - Fork 10k
[ADD] reference/external_json_api #14091
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great stuff! Clear and all! Just some little grammar stuff and a bit of nitpicks and that's basically all for me.
Thanks for the work 💪
f09670f
to
b774950
Compare
|
||
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
would be available is a bit speculative and makes it feel like we are not sure imo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
am not sure either, let's wait a 3rd opinion :)
b774950
to
6bfca17
Compare
No description provided.