Skip to content

Commit

Permalink
Deploying to gh-pages from @ 20a7df2 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
stuartc committed Jul 31, 2023
1 parent f91fb30 commit 4919c4c
Show file tree
Hide file tree
Showing 26 changed files with 286 additions and 286 deletions.
126 changes: 63 additions & 63 deletions Lightning.Accounts.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions Lightning.AdaptorRegistry.Npm.html
Original file line number Diff line number Diff line change
Expand Up @@ -1659,14 +1659,14 @@ <h1 class="signature" translate="no">request(request)</h1>
</a>
Examples
</h2>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p" data-group-id="3746242528-1">%</span><span class="nc" data-group-id="3746242528-1">HTTPoison.Request</span><span class="p" data-group-id="3746242528-1">{</span><span class="w">
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p" data-group-id="0700298803-1">%</span><span class="nc" data-group-id="0700298803-1">HTTPoison.Request</span><span class="p" data-group-id="0700298803-1">{</span><span class="w">
</span><span class="ss">method</span><span class="p">:</span><span class="w"> </span><span class="ss">:post</span><span class="p">,</span><span class="w">
</span><span class="ss">url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://my.website.com&quot;</span><span class="p">,</span><span class="w">
</span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{</span><span class="se">\&quot;</span><span class="s">foo</span><span class="se">\&quot;</span><span class="s">: 3}&quot;</span><span class="p">,</span><span class="w">
</span><span class="ss">headers</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3746242528-2">[</span><span class="p" data-group-id="3746242528-3">{</span><span class="s">&quot;Accept&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;application/json&quot;</span><span class="p" data-group-id="3746242528-3">}</span><span class="p" data-group-id="3746242528-2">]</span><span class="w">
</span><span class="p" data-group-id="3746242528-1">}</span><span class="w">
</span><span class="ss">headers</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0700298803-2">[</span><span class="p" data-group-id="0700298803-3">{</span><span class="s">&quot;Accept&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;application/json&quot;</span><span class="p" data-group-id="0700298803-3">}</span><span class="p" data-group-id="0700298803-2">]</span><span class="w">
</span><span class="p" data-group-id="0700298803-1">}</span><span class="w">

</span><span class="n">request</span><span class="p" data-group-id="3746242528-4">(</span><span class="n">request</span><span class="p" data-group-id="3746242528-4">)</span></code></pre>
</span><span class="n">request</span><span class="p" data-group-id="0700298803-4">(</span><span class="n">request</span><span class="p" data-group-id="0700298803-4">)</span></code></pre>
</section>
</section>
<section class="detail" id="request/5">
Expand Down Expand Up @@ -1724,7 +1724,7 @@ <h1 class="signature" translate="no">request(method, url, body \\ &quot;&quot;,
</a>
Examples
</h2>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="p" data-group-id="5330025589-1">(</span><span class="ss">:post</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;https://my.website.com&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;{</span><span class="se">\&quot;</span><span class="s">foo</span><span class="se">\&quot;</span><span class="s">: 3}&quot;</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5330025589-2">[</span><span class="p" data-group-id="5330025589-3">{</span><span class="s">&quot;Accept&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;application/json&quot;</span><span class="p" data-group-id="5330025589-3">}</span><span class="p" data-group-id="5330025589-2">]</span><span class="p" data-group-id="5330025589-1">)</span></code></pre>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="p" data-group-id="5290197536-1">(</span><span class="ss">:post</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;https://my.website.com&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;{</span><span class="se">\&quot;</span><span class="s">foo</span><span class="se">\&quot;</span><span class="s">: 3}&quot;</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5290197536-2">[</span><span class="p" data-group-id="5290197536-3">{</span><span class="s">&quot;Accept&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;application/json&quot;</span><span class="p" data-group-id="5290197536-3">}</span><span class="p" data-group-id="5290197536-2">]</span><span class="p" data-group-id="5290197536-1">)</span></code></pre>
</section>
</section>
<section class="detail" id="request!/5">
Expand Down
12 changes: 6 additions & 6 deletions Lightning.AdaptorRegistry.html
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,9 @@ <h1>
<p>Registry process to query and maintain a list of adaptors available for
writing jobs.</p><p>Currently it queries NPM for all modules in the <code class="inline">@openfn</code> organization and
filters out modules that are known not to be adaptors.</p><p><strong>Usage</strong></p><pre><code class="makeup elixir" translate="no"><span class="c1"># Starting the process</span><span class="w">
</span><span class="nc">AdaptorRegistry</span><span class="o">.</span><span class="n">start_link</span><span class="p" data-group-id="7409595376-1">(</span><span class="p" data-group-id="7409595376-1">)</span><span class="w">
</span><span class="nc">AdaptorRegistry</span><span class="o">.</span><span class="n">start_link</span><span class="p" data-group-id="0681938638-1">(</span><span class="p" data-group-id="0681938638-1">)</span><span class="w">
</span><span class="c1"># Getting a list of all adaptors</span><span class="w">
</span><span class="nc">Lightning.AdaptorRegistry.AdaptorRegistry</span><span class="o">.</span><span class="n">all</span><span class="p" data-group-id="7409595376-2">(</span><span class="p" data-group-id="7409595376-2">)</span></code></pre><p><strong>Caching</strong></p><p>By default the results are cached to disk, and will be reused every start.</p><p>In order to disable or configure caching pass see: <a href="#start_link/1"><code class="inline">start_link/1</code></a>.</p><p>The process uses <code class="inline">:continue</code> to return before the adaptors have been queried.
</span><span class="nc">Lightning.AdaptorRegistry.AdaptorRegistry</span><span class="o">.</span><span class="n">all</span><span class="p" data-group-id="0681938638-2">(</span><span class="p" data-group-id="0681938638-2">)</span></code></pre><p><strong>Caching</strong></p><p>By default the results are cached to disk, and will be reused every start.</p><p>In order to disable or configure caching pass see: <a href="#start_link/1"><code class="inline">start_link/1</code></a>.</p><p>The process uses <code class="inline">:continue</code> to return before the adaptors have been queried.
This does mean that the first call to the process will be delayed until
the <code class="inline">handle_continue/2</code> has finished.</p><p><strong>Timeouts</strong></p><p>There is a 'general' timeout of 30s, this is used for GenServer calls like
<a href="#all/1"><code class="inline">all/1</code></a> and also internally when the modules are being queried. NPM can
Expand Down Expand Up @@ -411,10 +411,10 @@ <h1 class="signature" translate="no">resolve_package_name(package_name)</h1>

</div>

<p>Destructures an NPM style package name into module name and version.</p><p><strong>Example</strong></p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="2136715900-1">(</span><span class="s">&quot;@openfn/[email protected]&quot;</span><span class="p" data-group-id="2136715900-1">)</span><span class="w">
</span><span class="p" data-group-id="2136715900-2">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;1.2.3&quot;</span><span class="w"> </span><span class="p" data-group-id="2136715900-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="2136715900-3">(</span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p" data-group-id="2136715900-3">)</span><span class="w">
</span><span class="p" data-group-id="2136715900-4">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="no">nil</span><span class="w"> </span><span class="p" data-group-id="2136715900-4">}</span></code></pre>
<p>Destructures an NPM style package name into module name and version.</p><p><strong>Example</strong></p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="6219447239-1">(</span><span class="s">&quot;@openfn/[email protected]&quot;</span><span class="p" data-group-id="6219447239-1">)</span><span class="w">
</span><span class="p" data-group-id="6219447239-2">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;1.2.3&quot;</span><span class="w"> </span><span class="p" data-group-id="6219447239-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="6219447239-3">(</span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p" data-group-id="6219447239-3">)</span><span class="w">
</span><span class="p" data-group-id="6219447239-4">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="no">nil</span><span class="w"> </span><span class="p" data-group-id="6219447239-4">}</span></code></pre>
</section>
</section>
<section class="detail" id="resolve_package_name!/1">
Expand Down
8 changes: 4 additions & 4 deletions Lightning.AttemptService.html
Original file line number Diff line number Diff line change
Expand Up @@ -354,11 +354,11 @@ <h1 class="signature" translate="no">create_attempt(work_order, job, reason)</h1
</a>
Examples
</h2>
<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">create_attempt</span><span class="p" data-group-id="0861982273-1">(</span><span class="p" data-group-id="0861982273-2">%{</span><span class="ss">field</span><span class="p">:</span><span class="w"> </span><span class="n">value</span><span class="p" data-group-id="0861982273-2">}</span><span class="p" data-group-id="0861982273-1">)</span><span class="w">
</span><span class="p" data-group-id="0861982273-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0861982273-4">%</span><span class="nc" data-group-id="0861982273-4">Attempt</span><span class="p" data-group-id="0861982273-4">{</span><span class="p" data-group-id="0861982273-4">}</span><span class="p" data-group-id="0861982273-3">}</span><span class="w">
<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">create_attempt</span><span class="p" data-group-id="0650358209-1">(</span><span class="p" data-group-id="0650358209-2">%{</span><span class="ss">field</span><span class="p">:</span><span class="w"> </span><span class="n">value</span><span class="p" data-group-id="0650358209-2">}</span><span class="p" data-group-id="0650358209-1">)</span><span class="w">
</span><span class="p" data-group-id="0650358209-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0650358209-4">%</span><span class="nc" data-group-id="0650358209-4">Attempt</span><span class="p" data-group-id="0650358209-4">{</span><span class="p" data-group-id="0650358209-4">}</span><span class="p" data-group-id="0650358209-3">}</span><span class="w">

</span><span class="gp unselectable">iex&gt; </span><span class="n">create_attempt</span><span class="p" data-group-id="0861982273-5">(</span><span class="p" data-group-id="0861982273-6">%{</span><span class="ss">field</span><span class="p">:</span><span class="w"> </span><span class="n">bad_value</span><span class="p" data-group-id="0861982273-6">}</span><span class="p" data-group-id="0861982273-5">)</span><span class="w">
</span><span class="p" data-group-id="0861982273-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0861982273-8">%</span><span class="nc" data-group-id="0861982273-8">Ecto.Changeset</span><span class="p" data-group-id="0861982273-8">{</span><span class="p" data-group-id="0861982273-8">}</span><span class="p" data-group-id="0861982273-7">}</span></code></pre>
</span><span class="gp unselectable">iex&gt; </span><span class="n">create_attempt</span><span class="p" data-group-id="0650358209-5">(</span><span class="p" data-group-id="0650358209-6">%{</span><span class="ss">field</span><span class="p">:</span><span class="w"> </span><span class="n">bad_value</span><span class="p" data-group-id="0650358209-6">}</span><span class="p" data-group-id="0650358209-5">)</span><span class="w">
</span><span class="p" data-group-id="0650358209-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0650358209-8">%</span><span class="nc" data-group-id="0650358209-8">Ecto.Changeset</span><span class="p" data-group-id="0650358209-8">{</span><span class="p" data-group-id="0650358209-8">}</span><span class="p" data-group-id="0650358209-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="get_for_rerun/2">
Expand Down
10 changes: 5 additions & 5 deletions Lightning.AuthProviders.WellKnown.html
Original file line number Diff line number Diff line change
Expand Up @@ -1834,14 +1834,14 @@ <h1 class="signature" translate="no">request(request)</h1>
</a>
Examples
</h2>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p" data-group-id="0813639642-1">%</span><span class="nc" data-group-id="0813639642-1">HTTPoison.Request</span><span class="p" data-group-id="0813639642-1">{</span><span class="w">
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p" data-group-id="4962517770-1">%</span><span class="nc" data-group-id="4962517770-1">HTTPoison.Request</span><span class="p" data-group-id="4962517770-1">{</span><span class="w">
</span><span class="ss">method</span><span class="p">:</span><span class="w"> </span><span class="ss">:post</span><span class="p">,</span><span class="w">
</span><span class="ss">url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://my.website.com&quot;</span><span class="p">,</span><span class="w">
</span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{</span><span class="se">\&quot;</span><span class="s">foo</span><span class="se">\&quot;</span><span class="s">: 3}&quot;</span><span class="p">,</span><span class="w">
</span><span class="ss">headers</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0813639642-2">[</span><span class="p" data-group-id="0813639642-3">{</span><span class="s">&quot;Accept&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;application/json&quot;</span><span class="p" data-group-id="0813639642-3">}</span><span class="p" data-group-id="0813639642-2">]</span><span class="w">
</span><span class="p" data-group-id="0813639642-1">}</span><span class="w">
</span><span class="ss">headers</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="4962517770-2">[</span><span class="p" data-group-id="4962517770-3">{</span><span class="s">&quot;Accept&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;application/json&quot;</span><span class="p" data-group-id="4962517770-3">}</span><span class="p" data-group-id="4962517770-2">]</span><span class="w">
</span><span class="p" data-group-id="4962517770-1">}</span><span class="w">

</span><span class="n">request</span><span class="p" data-group-id="0813639642-4">(</span><span class="n">request</span><span class="p" data-group-id="0813639642-4">)</span></code></pre>
</span><span class="n">request</span><span class="p" data-group-id="4962517770-4">(</span><span class="n">request</span><span class="p" data-group-id="4962517770-4">)</span></code></pre>
</section>
</section>
<section class="detail" id="request/5">
Expand Down Expand Up @@ -1899,7 +1899,7 @@ <h1 class="signature" translate="no">request(method, url, body \\ &quot;&quot;,
</a>
Examples
</h2>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="p" data-group-id="8175643484-1">(</span><span class="ss">:post</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;https://my.website.com&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;{</span><span class="se">\&quot;</span><span class="s">foo</span><span class="se">\&quot;</span><span class="s">: 3}&quot;</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8175643484-2">[</span><span class="p" data-group-id="8175643484-3">{</span><span class="s">&quot;Accept&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;application/json&quot;</span><span class="p" data-group-id="8175643484-3">}</span><span class="p" data-group-id="8175643484-2">]</span><span class="p" data-group-id="8175643484-1">)</span></code></pre>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="p" data-group-id="7336441602-1">(</span><span class="ss">:post</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;https://my.website.com&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;{</span><span class="se">\&quot;</span><span class="s">foo</span><span class="se">\&quot;</span><span class="s">: 3}&quot;</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="7336441602-2">[</span><span class="p" data-group-id="7336441602-3">{</span><span class="s">&quot;Accept&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;application/json&quot;</span><span class="p" data-group-id="7336441602-3">}</span><span class="p" data-group-id="7336441602-2">]</span><span class="p" data-group-id="7336441602-1">)</span></code></pre>
</section>
</section>
<section class="detail" id="request!/5">
Expand Down
Loading

0 comments on commit 4919c4c

Please sign in to comment.