diff options
| author | Victor Feyens <vfe@odoo.com> | 2019-04-18 09:43:01 +0000 |
|---|---|---|
| committer | fw-bot <otis@odoo.com> | 2019-10-25 15:25:00 +0000 |
| commit | 1b87271106330e26f27515af73e17ec12e79a458 (patch) | |
| tree | ebf10c7eca866871160c29b9dd9f23845d9aaf04 /doc/reference | |
| parent | 3917aa5fa2200e551e6de8b10c234b0499bde05f (diff) | |
[IMP] doc: controllers organisation + minor correction
X-original-commit: c58751f21b49173cb51afd9ff2f01077f7610fb5
Diffstat (limited to 'doc/reference')
| -rw-r--r-- | doc/reference/http.rst | 82 | ||||
| -rw-r--r-- | doc/reference/views.rst | 2 |
2 files changed, 42 insertions, 42 deletions
diff --git a/doc/reference/http.rst b/doc/reference/http.rst index 9dbb61f7727..0675847aaa0 100644 --- a/doc/reference/http.rst +++ b/doc/reference/http.rst @@ -1,45 +1,11 @@ :banner: banners/web_controllers.jpg +.. _reference/controllers: + =============== Web Controllers =============== -.. _reference/http/routing: - -Routing -======= - -.. autofunction:: odoo.http.route - -.. _reference/http/request: - -Request -======= - -The request object is automatically set on :data:`odoo.http.request` at -the start of the request - -.. autoclass:: odoo.http.WebRequest - :members: - :member-order: bysource -.. autoclass:: odoo.http.HttpRequest - :members: -.. autoclass:: odoo.http.JsonRequest - :members: - -Response -======== - -.. autoclass:: odoo.http.Response - :members: - :member-order: bysource - - .. maybe set this to document all the fine methods on Werkzeug's Response - object? (it works) - :inherited-members: - -.. _reference/http/controllers: - Controllers =========== @@ -51,11 +17,8 @@ no database created, or no database selected). Controllers thus provide their own extension mechanism, separate from that of models: -Controllers are created by :ref:`inheriting <python:tut-inheritance>` from - -.. autoclass:: odoo.http.Controller - -and defining methods decorated with :func:`~odoo.http.route`:: +Controllers are created by :ref:`inheriting <python:tut-inheritance>` from :class:`~odoo.http.Controller`. +Routes are defined through methods decorated with :func:`~odoo.http.route`:: class MyController(odoo.http.Controller): @route('/some_url', auth='public') @@ -85,3 +48,40 @@ class and override relevant methods, re-exposing them if necessary:: will change ``/some_url`` from public authentication to user (requiring a log-in) + +API +=== + +.. _reference/http/routing: + +Routing +------- + +.. autofunction:: odoo.http.route + +.. _reference/http/request: + +Request +------- + +The request object is automatically set on :data:`odoo.http.request` at +the start of the request + +.. autoclass:: odoo.http.WebRequest + :members: + :member-order: bysource +.. autoclass:: odoo.http.HttpRequest + :members: +.. autoclass:: odoo.http.JsonRequest + :members: + +Response +-------- + +.. autoclass:: odoo.http.Response + :members: + :member-order: bysource + + .. maybe set this to document all the fine methods on Werkzeug's Response + object? (it works) + :inherited-members: diff --git a/doc/reference/views.rst b/doc/reference/views.rst index 8dadae4cac2..ed678aaf004 100644 --- a/doc/reference/views.rst +++ b/doc/reference/views.rst @@ -48,7 +48,7 @@ otherwise. a route address to be fetched and prepended to the view. If this attribute is set, the - :ref:`controller route url<reference/http/controllers>` will be fetched and + :ref:`controller route url<reference/controllers>` will be fetched and displayed above the view. The json response from the controller should contain an "html" key. |
