edi_webservice_oca: fix README

Author: gurneyalex

edi_webservice_oca/README.rst

@@ -7,7 +7,7 @@ EDI WebService
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:e3c80bfc8c2e03579682be217715bbd2d93504d9d2cda9770e0e8eae2c2de605
+   !! source digest: sha256:84f4a9839ab2f338128c71358484eb5a37f372aa58e5d06c925aa41908f7fcd6
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -36,6 +36,44 @@ Allows to configure attach webservices on an EDI backend and/or on an exchange t
 .. contents::
    :local:
 
+Configuration
+=============
+
+Go to "EDI -> Config -> Backends" and edit or create one.
+Find the tab "Webservice" and add a webservice.
+On the webservice record you can specify all the general parameters to connect to the service
+(see `webservice` README for more details).
+
+If you want to take full control on if/how the webservice is used
+you can do it via exchange type's advanced settings.
+
+Hence, assuming your webservice has a URL configured as `https://my.endpoint/{path}`::
+
+  components:
+    send:
+      usage: webservice.send  # or any custom component usage inheriting from this
+      work_ctx:
+        webservice:
+          method: post  # mandatory
+          url_params:
+            path: endpoint1/foo
+
+
+For each call related to this type, you'll get a POST request against
+`https://my.endpoint/endpoint/foo`.
+
+``url_params`` can contain all the keys need for URL interpolation.
+
+In addition, you can user ``url`` to override the full url used for the call
+per exchange type.
+
+If you want to send data as bytes you can use the option `send_as_bytes` like::
+
+  [...]
+        webservice:
+          send_as_bytes: true
+  [...]
+
 Bug Tracker
 ===========
 

edi_webservice_oca/readme/CONFIGURATION.rst edi_webservice_oca/readme/CONFIGURE.rst

@@ -367,49 +367,82 @@ <h1 class="title">EDI WebService</h1>
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-!! source digest: sha256:e3c80bfc8c2e03579682be217715bbd2d93504d9d2cda9770e0e8eae2c2de605
+!! source digest: sha256:84f4a9839ab2f338128c71358484eb5a37f372aa58e5d06c925aa41908f7fcd6
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/edi/tree/15.0/edi_webservice_oca"><img alt="OCA/edi" src="https://img.shields.io/badge/github-OCA%2Fedi-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/edi-15-0/edi-15-0-edi_webservice_oca"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/edi&amp;target_branch=15.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>Plug <cite>webservice</cite> module within EDI framework.
 Allows to configure attach webservices on an EDI backend and/or on an exchange type.</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#bug-tracker" id="toc-entry-1">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="toc-entry-2">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="toc-entry-3">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="toc-entry-4">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-5">Maintainers</a></li>
+<li><a class="reference internal" href="#configuration" id="toc-entry-1">Configuration</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
+<div class="section" id="configuration">
+<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
+<p>Go to “EDI -&gt; Config -&gt; Backends” and edit or create one.
+Find the tab “Webservice” and add a webservice.
+On the webservice record you can specify all the general parameters to connect to the service
+(see <cite>webservice</cite> README for more details).</p>
+<p>If you want to take full control on if/how the webservice is used
+you can do it via exchange type’s advanced settings.</p>
+<p>Hence, assuming your webservice has a URL configured as <cite>https://my.endpoint/{path}</cite>:</p>
+<pre class="literal-block">
+components:
+  send:
+    usage: webservice.send  # or any custom component usage inheriting from this
+    work_ctx:
+      webservice:
+        method: post  # mandatory
+        url_params:
+          path: endpoint1/foo
+</pre>
+<p>For each call related to this type, you’ll get a POST request against
+<cite>https://my.endpoint/endpoint/foo</cite>.</p>
+<p><tt class="docutils literal">url_params</tt> can contain all the keys need for URL interpolation.</p>
+<p>In addition, you can user <tt class="docutils literal">url</tt> to override the full url used for the call
+per exchange type.</p>
+<p>If you want to send data as bytes you can use the option <cite>send_as_bytes</cite> like:</p>
+<pre class="literal-block">
+[...]
+      webservice:
+        send_as_bytes: true
+[...]
+</pre>
+</div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/edi/issues">GitHub Issues</a>.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
 <a class="reference external" href="https://github.com/OCA/edi/issues/new?body=module:%20edi_webservice_oca%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
-<h1><a class="toc-backref" href="#toc-entry-2">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-3">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-3">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
 <ul class="simple">
 <li>Creu Blanca</li>
 <li>Camptocamp</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#toc-entry-4">Contributors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
 <ul class="simple">
 <li>Enric Tobella &lt;<a class="reference external" href="mailto:etobella&#64;creublanca.es">etobella&#64;creublanca.es</a>&gt;</li>
 <li>Simone Orsi &lt;<a class="reference external" href="mailto:simone.orsi&#64;camptocamp.com">simone.orsi&#64;camptocamp.com</a>&gt;</li>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-5">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
 <p>This module is maintained by the OCA.</p>
 <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
 <p>OCA, or the Odoo Community Association, is a nonprofit organization whose