diff --git a/usability_webhooks/README.rst b/usability_webhooks/README.rst index 0cc1cea..5b719ac 100644 --- a/usability_webhooks/README.rst +++ b/usability_webhooks/README.rst @@ -81,10 +81,10 @@ Following successful authentication, you can proceed with 5 API routes: "model": "", "vals": { "payload": { - "field1": "value1", + "": "", ... }, - "result_field": ["field1", ...] # optional + "result_field": ["", ...] # optional } } } @@ -100,13 +100,13 @@ Following successful authentication, you can proceed with 5 API routes: "model": "", "vals": { "search_key": { - "": "value", # can be ID or name search string + "": "", # can be ID or name search string }, "payload": { - "field1": "value1", + "": "", ... }, - "result_field": ["field1", ...] # optional + "result_field": ["", ...] # optional } } } @@ -121,12 +121,13 @@ Following successful authentication, you can proceed with 5 API routes: "model": "", "vals": { "search_key": { - "": "value", # can be ID or name search string + "": "", # can be ID or name search string }, "payload": { - "field1": "value1", + "": "", ... - } + }, + "result_field": ["", ...] # optional } } } @@ -141,10 +142,10 @@ Following successful authentication, you can proceed with 5 API routes: "model": "", "vals": { "payload": { - "search_field": ["field1", "field2", "field3{subfield1, subfield2}", ...], - "search_domain": "[('field', 'operator', 'value')]", + "search_field": ["", "", "{, }", ...], + "search_domain": "[('', '', '')]", "limit": 1, - "order": "field1 , field2 desc, ..." + "order": " , desc, ..." } } } @@ -164,7 +165,7 @@ Following successful authentication, you can proceed with 5 API routes: "model": "", "vals": { "search_key": { - "": "value", # can be ID or name search string + "": "", # can be ID or name search string }, "payload": { "method": "", diff --git a/usability_webhooks/readme/USAGE.rst b/usability_webhooks/readme/USAGE.rst index 0f230cb..a6ed435 100644 --- a/usability_webhooks/readme/USAGE.rst +++ b/usability_webhooks/readme/USAGE.rst @@ -41,10 +41,10 @@ Following successful authentication, you can proceed with 5 API routes: "model": "", "vals": { "payload": { - "field1": "value1", + "": "", ... }, - "result_field": ["field1", ...] # optional + "result_field": ["", ...] # optional } } } @@ -60,13 +60,13 @@ Following successful authentication, you can proceed with 5 API routes: "model": "", "vals": { "search_key": { - "": "value", # can be ID or name search string + "": "", # can be ID or name search string }, "payload": { - "field1": "value1", + "": "", ... }, - "result_field": ["field1", ...] # optional + "result_field": ["", ...] # optional } } } @@ -81,12 +81,13 @@ Following successful authentication, you can proceed with 5 API routes: "model": "", "vals": { "search_key": { - "": "value", # can be ID or name search string + "": "", # can be ID or name search string }, "payload": { - "field1": "value1", + "": "", ... - } + }, + "result_field": ["", ...] # optional } } } @@ -101,10 +102,10 @@ Following successful authentication, you can proceed with 5 API routes: "model": "", "vals": { "payload": { - "search_field": ["field1", "field2", "field3{subfield1, subfield2}", ...], - "search_domain": "[('field', 'operator', 'value')]", + "search_field": ["", "", "{, }", ...], + "search_domain": "[('', '', '')]", "limit": 1, - "order": "field1 , field2 desc, ..." + "order": " , desc, ..." } } } @@ -124,7 +125,7 @@ Following successful authentication, you can proceed with 5 API routes: "model": "", "vals": { "search_key": { - "": "value", # can be ID or name search string + "": "", # can be ID or name search string }, "payload": { "method": "", diff --git a/usability_webhooks/static/description/index.html b/usability_webhooks/static/description/index.html index 60c2645..019e99b 100644 --- a/usability_webhooks/static/description/index.html +++ b/usability_webhooks/static/description/index.html @@ -424,10 +424,10 @@

Usage

"model": "<model name>", "vals": { "payload": { - "field1": "value1", + "<field1>": "<value1>", ... }, - "result_field": ["field1", ...] # optional + "result_field": ["<field1>", ...] # optional } } } @@ -442,13 +442,13 @@

Usage

"model": "<model name>", "vals": { "search_key": { - "<key_field>": "value", # can be ID or name search string + "<key_field>": "<value>", # can be ID or name search string }, "payload": { - "field1": "value1", + "<field1>": "<value1>", ... }, - "result_field": ["field1", ...] # optional + "result_field": ["<field1>", ...] # optional } } } @@ -462,12 +462,13 @@

Usage

"model": "<model name>", "vals": { "search_key": { - "<key_field>": "value", # can be ID or name search string + "<key_field>": "<value>", # can be ID or name search string }, "payload": { - "field1": "value1", + "<field1>": "<value1>", ... - } + }, + "result_field": ["<field1>", ...] # optional } } } @@ -481,10 +482,10 @@

Usage

"model": "<model name>", "vals": { "payload": { - "search_field": ["field1", "field2", "field3{subfield1, subfield2}", ...], - "search_domain": "[('field', 'operator', 'value')]", + "search_field": ["<field1>", "<field2>", "<field3>{<subfield1>, <subfield2>}", ...], + "search_domain": "[('<field>', '<operator>', '<value>')]", "limit": 1, - "order": "field1 , field2 desc, ..." + "order": "<field1> , <field2> desc, ..." } } } @@ -507,7 +508,7 @@

Usage

"model": "<model name>", "vals": { "search_key": { - "<key_field>": "value", # can be ID or name search string + "<key_field>": "<value>", # can be ID or name search string }, "payload": { "method": "<method>",