Merge pull request #206 from ecosoft-odoo/15.0-imp-usability_webhooks…

…_search_2many [15.0][FIX] usability_webhooks: fix readme format json
ecosoft-odoo · Oct 1, 2024 · b988107 · b988107
2 parents 4d2015f + 4062edc
commit b988107
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 24 deletions.
diff --git a/usability_webhooks/README.rst b/usability_webhooks/README.rst
@@ -69,7 +69,7 @@ Following successful authentication, you can proceed with five API routes:
             "vals": {
                "payload": {
                   "field1": "value1",
-                  ...
+                  // other fields
                }
             }
          }
@@ -85,9 +85,9 @@ Following successful authentication, you can proceed with five API routes:
          "params": {
             "model": "<model name>",
             "vals": {
-               "<unique key>": "value",  # can be ID or name search string
+               "<unique key>": "value",  // can be ID or name search string
                "field1": "value1",
-               ...
+               // other fields
             }
          }
       }
@@ -102,9 +102,9 @@ Following successful authentication, you can proceed with five API routes:
             "model": "<model name>",
             "vals": {
                "payload": {
-                  "<unique key>": "value",  # can be ID or name search string
+                  "<unique key>": "value",  // can be ID or name search string
                   "field1": "value1",
-                  ...
+                  // other fields
                }
             }
          }
@@ -120,10 +120,10 @@ Following successful authentication, you can proceed with five API routes:
             "model": "<model name>",
             "vals": {
                "payload": {
-                  "search_field": ["field1", "field2", "field3{subfield1, subfield2}", ...],
+                  "search_field": ["field1", "field2", "field3{subfield1, subfield2}"],
                   "search_domain": "[('field', 'operator', 'value')]",
                   "limit": 1,
-                  "order": "field1 , field2 desc, ..."
+                  "order": "field1 , field2 desc"
                }
             }
          }
@@ -145,7 +145,7 @@ Following successful authentication, you can proceed with five API routes:
                "payload": {
                   "name": "<name>",
                   "method": "<method>",
-                  "parameter": {"<key>": "<value>", ...}
+                  "parameter": {"<key>": "<value>"}
                }
             }
          }

diff --git a/usability_webhooks/readme/USAGE.rst b/usability_webhooks/readme/USAGE.rst
@@ -29,7 +29,7 @@ Following successful authentication, you can proceed with five API routes:
             "vals": {
                "payload": {
                   "field1": "value1",
-                  ...
+                  // other fields
                }
             }
          }
@@ -45,9 +45,9 @@ Following successful authentication, you can proceed with five API routes:
          "params": {
             "model": "<model name>",
             "vals": {
-               "<unique key>": "value",  # can be ID or name search string
+               "<unique key>": "value",  // can be ID or name search string
                "field1": "value1",
-               ...
+               // other fields
             }
          }
       }
@@ -62,9 +62,9 @@ Following successful authentication, you can proceed with five API routes:
             "model": "<model name>",
             "vals": {
                "payload": {
-                  "<unique key>": "value",  # can be ID or name search string
+                  "<unique key>": "value",  // can be ID or name search string
                   "field1": "value1",
-                  ...
+                  // other fields
                }
             }
          }
@@ -80,10 +80,10 @@ Following successful authentication, you can proceed with five API routes:
             "model": "<model name>",
             "vals": {
                "payload": {
-                  "search_field": ["field1", "field2", "field3{subfield1, subfield2}", ...],
+                  "search_field": ["field1", "field2", "field3{subfield1, subfield2}"],
                   "search_domain": "[('field', 'operator', 'value')]",
                   "limit": 1,
-                  "order": "field1 , field2 desc, ..."
+                  "order": "field1 , field2 desc"
                }
             }
          }
@@ -105,7 +105,7 @@ Following successful authentication, you can proceed with five API routes:
                "payload": {
                   "name": "<name>",
                   "method": "<method>",
-                  "parameter": {"<key>": "<value>", ...}
+                  "parameter": {"<key>": "<value>"}
                }
             }
          }

diff --git a/usability_webhooks/static/description/index.html b/usability_webhooks/static/description/index.html
@@ -418,7 +418,7 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
       </span><span class="nt">&quot;vals&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
          </span><span class="nt">&quot;payload&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
             </span><span class="nt">&quot;field1&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;value1&quot;</span><span class="p">,</span><span class="w">
-            </span><span class="err">...</span><span class="w">
+            </span><span class="c1">// other fields</span><span class="w">
          </span><span class="p">}</span><span class="w">
       </span><span class="p">}</span><span class="w">
    </span><span class="p">}</span><span class="w">
@@ -433,9 +433,9 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
    </span><span class="nt">&quot;params&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
       </span><span class="nt">&quot;model&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&lt;model name&gt;&quot;</span><span class="p">,</span><span class="w">
       </span><span class="nt">&quot;vals&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
-         </span><span class="nt">&quot;&lt;unique key&gt;&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="p">,</span><span class="w">  </span><span class="err">#</span><span class="w"> </span><span class="err">ca</span><span class="kc">n</span><span class="w"> </span><span class="err">be</span><span class="w"> </span><span class="err">ID</span><span class="w"> </span><span class="err">or</span><span class="w"> </span><span class="kc">na</span><span class="err">me</span><span class="w"> </span><span class="err">search</span><span class="w"> </span><span class="err">s</span><span class="kc">tr</span><span class="err">i</span><span class="kc">n</span><span class="err">g</span><span class="w">
+         </span><span class="nt">&quot;&lt;unique key&gt;&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="p">,</span><span class="w">  </span><span class="c1">// can be ID or name search string</span><span class="w">
          </span><span class="nt">&quot;field1&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;value1&quot;</span><span class="p">,</span><span class="w">
-         </span><span class="err">...</span><span class="w">
+         </span><span class="c1">// other fields</span><span class="w">
       </span><span class="p">}</span><span class="w">
    </span><span class="p">}</span><span class="w">
 </span><span class="p">}</span>
@@ -449,9 +449,9 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
       </span><span class="nt">&quot;model&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&lt;model name&gt;&quot;</span><span class="p">,</span><span class="w">
       </span><span class="nt">&quot;vals&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
          </span><span class="nt">&quot;payload&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
-            </span><span class="nt">&quot;&lt;unique key&gt;&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="p">,</span><span class="w">  </span><span class="err">#</span><span class="w"> </span><span class="err">ca</span><span class="kc">n</span><span class="w"> </span><span class="err">be</span><span class="w"> </span><span class="err">ID</span><span class="w"> </span><span class="err">or</span><span class="w"> </span><span class="kc">na</span><span class="err">me</span><span class="w"> </span><span class="err">search</span><span class="w"> </span><span class="err">s</span><span class="kc">tr</span><span class="err">i</span><span class="kc">n</span><span class="err">g</span><span class="w">
+            </span><span class="nt">&quot;&lt;unique key&gt;&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="p">,</span><span class="w">  </span><span class="c1">// can be ID or name search string</span><span class="w">
             </span><span class="nt">&quot;field1&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;value1&quot;</span><span class="p">,</span><span class="w">
-            </span><span class="err">...</span><span class="w">
+            </span><span class="c1">// other fields</span><span class="w">
          </span><span class="p">}</span><span class="w">
       </span><span class="p">}</span><span class="w">
    </span><span class="p">}</span><span class="w">
@@ -466,10 +466,10 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
       </span><span class="nt">&quot;model&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&lt;model name&gt;&quot;</span><span class="p">,</span><span class="w">
       </span><span class="nt">&quot;vals&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
          </span><span class="nt">&quot;payload&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
-            </span><span class="nt">&quot;search_field&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;field1&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;field2&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;field3{subfield1, subfield2}&quot;</span><span class="p">,</span><span class="w"> </span><span class="err">...</span><span class="p">],</span><span class="w">
+            </span><span class="nt">&quot;search_field&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;field1&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;field2&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;field3{subfield1, subfield2}&quot;</span><span class="p">],</span><span class="w">
             </span><span class="nt">&quot;search_domain&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[('field', 'operator', 'value')]&quot;</span><span class="p">,</span><span class="w">
             </span><span class="nt">&quot;limit&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
-            </span><span class="nt">&quot;order&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;field1 , field2 desc, ...&quot;</span><span class="w">
+            </span><span class="nt">&quot;order&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;field1 , field2 desc&quot;</span><span class="w">
          </span><span class="p">}</span><span class="w">
       </span><span class="p">}</span><span class="w">
    </span><span class="p">}</span><span class="w">
@@ -494,7 +494,7 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
          </span><span class="nt">&quot;payload&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
             </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&lt;name&gt;&quot;</span><span class="p">,</span><span class="w">
             </span><span class="nt">&quot;method&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&lt;method&gt;&quot;</span><span class="p">,</span><span class="w">
-            </span><span class="nt">&quot;parameter&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;&lt;key&gt;&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&lt;value&gt;&quot;</span><span class="p">,</span><span class="w"> </span><span class="err">...</span><span class="p">}</span><span class="w">
+            </span><span class="nt">&quot;parameter&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;&lt;key&gt;&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&lt;value&gt;&quot;</span><span class="p">}</span><span class="w">
          </span><span class="p">}</span><span class="w">
       </span><span class="p">}</span><span class="w">
    </span><span class="p">}</span><span class="w">