Skip to content
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

[14.0][IMP] base_rest: show first-level menu to admins only #425

Open
wants to merge 1 commit into
base: 14.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion base_rest/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ systems, therefore increasing maintenance costs.
Once developed, an `OpenApi <https://spec.openapis.org/oas/v3.0.3>`_ documentation
is generated from the source code and available via a
`Swagger UI <https://swagger.io/tools/swagger-ui/>`_ served by your odoo server
at `https://my_odoo_server/api-docs`.
at `https://my_odoo_server/api-docs`. There is also a convenience menu
visible by users with permission "Administration: Settings", but the
docs endpoint itself is public.

**Table of contents**

Expand Down
4 changes: 3 additions & 1 deletion base_rest/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,6 @@ systems, therefore increasing maintenance costs.
Once developed, an `OpenApi <https://spec.openapis.org/oas/v3.0.3>`_ documentation
is generated from the source code and available via a
`Swagger UI <https://swagger.io/tools/swagger-ui/>`_ served by your odoo server
at `https://my_odoo_server/api-docs`.
at `https://my_odoo_server/api-docs`. There is also a convenience menu
visible by users with permission "Administration: Settings", but the
docs endpoint itself is public.
4 changes: 3 additions & 1 deletion base_rest/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,9 @@ <h1 class="title">Base Rest</h1>
<p>Once developed, an <a class="reference external" href="https://spec.openapis.org/oas/v3.0.3">OpenApi</a> documentation
is generated from the source code and available via a
<a class="reference external" href="https://swagger.io/tools/swagger-ui/">Swagger UI</a> served by your odoo server
at <cite>https://my_odoo_server/api-docs</cite>.</p>
at <cite>https://my_odoo_server/api-docs</cite>. There is also a convenience menu
visible by users with permission “Administration: Settings”, but the
docs endpoint itself is public.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
Expand Down
2 changes: 1 addition & 1 deletion base_rest/views/base_rest_view.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
<!-- Copyright 2018 ACSONE SA/NV
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
<odoo>

<record id="menu_rest_api_root" model="ir.ui.menu">
<field name="name">REST API</field>
<field name="sequence" eval="400" />
<field name="web_icon">base_rest,static/description/icon.png</field>
<field name="groups_id" eval="[(4, ref('base.group_system'))]" />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aleuffre Thank you for this proposal. Why not... but something must be set into the readme to describe how you can get access to the REST api documentation.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've mentioned it in the readme as you suggested!

</record>

<record id="action_rest_api_docs" model="ir.actions.act_url">
Expand Down
Loading