Skip to content

Conversation

Julien00859
Copy link
Member

No description provided.

@robodoo
Copy link
Collaborator

robodoo commented Jul 18, 2025

Pull request status dashboard

@Julien00859 Julien00859 force-pushed the master-json2doc-juc branch 2 times, most recently from 078ad01 to 5230acf Compare July 18, 2025 10:53
@Julien00859 Julien00859 marked this pull request as draft July 18, 2025 10:54
@Julien00859 Julien00859 force-pushed the master-json2doc-juc branch 2 times, most recently from 088509f to f87ee68 Compare July 30, 2025 16:33
@Julien00859 Julien00859 marked this pull request as ready for review August 18, 2025 14:19
@C3POdoo C3POdoo requested review from a team August 18, 2025 14:27
Copy link
Collaborator

@AntoineVDV AntoineVDV left a 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.

@Julien00859
Copy link
Member Author

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.

Done

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.

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.

Copy link

@Flotchet Flotchet left a 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 💪

@xpl-odoo xpl-odoo removed the request for review from a team August 19, 2025 08:19

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;

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

Copy link
Member Author

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

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

Copy link
Member Author

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 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants