Skip to content

Commit 0e1b2a7

Browse files
committed
Add better documentation
1 parent c64ccff commit 0e1b2a7

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

src/magento-eqp-callback-parser.html

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,21 @@
3131

3232
<script type="text/html" data-help-name="magento-eqp-callback-parser">
3333
<p>A node to parse requests from a callback URL by the Magento Marketplace EQP API.</p>
34+
35+
<h4>Input</h4>
36+
<p>
37+
The incoming <code>msg.payload</code> should be either a
38+
<a href="https://netresearch.github.io/node-magento-eqp/interfaces/malwarescancompleteevent.html">
39+
<code>MalwareScanCompleteEvent</code>
40+
</a>
41+
or a
42+
<a href="https://netresearch.github.io/node-magento-eqp/interfaces/eqpstatusupdateevent.html"><code>EQPStatusUpdateEvent</code></a> .
43+
</p>
44+
45+
<h4>Output</h4>
46+
<p>
47+
The response (the return value of
48+
<a href="https://netresearch.github.io/node-magento-eqp/classes/eqp.html#parsecallback"><code>EQP#parseCallback()</code></a> ) will be written to
49+
<code>msg.payload</code>.
50+
</p>
3451
</script>

src/magento-eqp-register-callback.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,22 @@
3131

3232
<script type="text/html" data-help-name="magento-eqp-register-callback">
3333
<p>A node to register a callback URL on the Magento Marketplace EQP API.</p>
34+
35+
<h4>Input</h4>
36+
<p>
37+
The incoming <code>msg.payload</code> should look like this:
38+
39+
<ul>
40+
<li>name</li>
41+
<li>url</li>
42+
<li>username</li>
43+
<li>password</li>
44+
</ul>
45+
</p>
46+
47+
<h4>Output</h4>
48+
<p>
49+
The response (a <a href="https://netresearch.github.io/node-magento-eqp/interfaces/user.html"><code>User</code></a> object) will be
50+
written to <code>msg.payload</code>.
51+
</p>
3452
</script>

0 commit comments

Comments
 (0)