Skip to content

Commit

Permalink
Deploying to gh-pages from @ 2e586e0 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
taylordowns2000 committed Jan 19, 2024
1 parent 3e5cb45 commit 8a3f317
Show file tree
Hide file tree
Showing 39 changed files with 493 additions and 492 deletions.
2 changes: 1 addition & 1 deletion .build
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ dist/merriweather-latin-ext-300-normal-K6L27CZ5.woff2
dist/merriweather-vietnamese-300-italic-EHHNZPUO.woff2
dist/merriweather-vietnamese-300-normal-U376L4Z4.woff2
dist/remixicon-NKANDIL5.woff2
dist/search_data-B8AD0695.js
dist/search_data-69EC6075.js
dist/sidebar_items-D804BC33.js
index.html
provisioning.html
Expand Down
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 @@ -1679,14 +1679,14 @@ <h1 class="signature" translate="no">request(request)</h1>
</a>
<span class="text">Examples</span>
</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="5918905557-1">%</span><span class="nc" data-group-id="5918905557-1">HTTPoison.Request</span><span class="p" data-group-id="5918905557-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="9000674798-1">%</span><span class="nc" data-group-id="9000674798-1">HTTPoison.Request</span><span class="p" data-group-id="9000674798-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="5918905557-2">[</span><span class="p" data-group-id="5918905557-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="5918905557-3">}</span><span class="p" data-group-id="5918905557-2">]</span><span class="w">
</span><span class="p" data-group-id="5918905557-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="9000674798-2">[</span><span class="p" data-group-id="9000674798-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="9000674798-3">}</span><span class="p" data-group-id="9000674798-2">]</span><span class="w">
</span><span class="p" data-group-id="9000674798-1">}</span><span class="w">

</span><span class="n">request</span><span class="p" data-group-id="5918905557-4">(</span><span class="n">request</span><span class="p" data-group-id="5918905557-4">)</span></code></pre>
</span><span class="n">request</span><span class="p" data-group-id="9000674798-4">(</span><span class="n">request</span><span class="p" data-group-id="9000674798-4">)</span></code></pre>
</section>
</section>
<section class="detail" id="request/5">
Expand Down Expand Up @@ -1744,7 +1744,7 @@ <h1 class="signature" translate="no">request(method, url, body \\ &quot;&quot;,
</a>
<span class="text">Examples</span>
</h2>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="p" data-group-id="3901876477-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="3901876477-2">[</span><span class="p" data-group-id="3901876477-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="3901876477-3">}</span><span class="p" data-group-id="3901876477-2">]</span><span class="p" data-group-id="3901876477-1">)</span></code></pre>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="p" data-group-id="9106659760-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="9106659760-2">[</span><span class="p" data-group-id="9106659760-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="9106659760-3">}</span><span class="p" data-group-id="9106659760-2">]</span><span class="p" data-group-id="9106659760-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 @@ -140,9 +140,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="7600580450-1">(</span><span class="p" data-group-id="7600580450-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="7361302577-1">(</span><span class="p" data-group-id="7361302577-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="7600580450-2">(</span><span class="p" data-group-id="7600580450-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="7361302577-2">(</span><span class="p" data-group-id="7361302577-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 @@ -432,10 +432,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="0679194105-1">(</span><span class="s">&quot;@openfn/[email protected]&quot;</span><span class="p" data-group-id="0679194105-1">)</span><span class="w">
</span><span class="p" data-group-id="0679194105-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="0679194105-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="0679194105-3">(</span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p" data-group-id="0679194105-3">)</span><span class="w">
</span><span class="p" data-group-id="0679194105-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="0679194105-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="3702531882-1">(</span><span class="s">&quot;@openfn/[email protected]&quot;</span><span class="p" data-group-id="3702531882-1">)</span><span class="w">
</span><span class="p" data-group-id="3702531882-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="3702531882-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="3702531882-3">(</span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p" data-group-id="3702531882-3">)</span><span class="w">
</span><span class="p" data-group-id="3702531882-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="3702531882-4">}</span></code></pre>
</section>
</section>
<section class="detail" id="resolve_package_name!/1">
Expand Down
2 changes: 1 addition & 1 deletion Lightning.Attempts.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ <h1 class="signature" translate="no">get(id, opts \\ [])</h1>

</div>

<p>Get an Attempt by id.</p><p>Optionally preload associations by passing a list of atoms to <code class="inline">:include</code>.</p><pre><code class="makeup elixir" translate="no"><span class="nc">Lightning.Attempts</span><span class="o">.</span><span class="n">get</span><span class="p" data-group-id="0813350328-1">(</span><span class="n">id</span><span class="p">,</span><span class="w"> </span><span class="ss">include</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0813350328-2">[</span><span class="ss">:workflow</span><span class="p" data-group-id="0813350328-2">]</span><span class="p" data-group-id="0813350328-1">)</span></code></pre>
<p>Get an Attempt by id.</p><p>Optionally preload associations by passing a list of atoms to <code class="inline">:include</code>.</p><pre><code class="makeup elixir" translate="no"><span class="nc">Lightning.Attempts</span><span class="o">.</span><span class="n">get</span><span class="p" data-group-id="8831016142-1">(</span><span class="n">id</span><span class="p">,</span><span class="w"> </span><span class="ss">include</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="8831016142-2">[</span><span class="ss">:workflow</span><span class="p" data-group-id="8831016142-2">]</span><span class="p" data-group-id="8831016142-1">)</span></code></pre>
</section>
</section>
<section class="detail" id="get_credential/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 @@ -1854,14 +1854,14 @@ <h1 class="signature" translate="no">request(request)</h1>
</a>
<span class="text">Examples</span>
</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="6254056008-1">%</span><span class="nc" data-group-id="6254056008-1">HTTPoison.Request</span><span class="p" data-group-id="6254056008-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="4834514630-1">%</span><span class="nc" data-group-id="4834514630-1">HTTPoison.Request</span><span class="p" data-group-id="4834514630-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="6254056008-2">[</span><span class="p" data-group-id="6254056008-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="6254056008-3">}</span><span class="p" data-group-id="6254056008-2">]</span><span class="w">
</span><span class="p" data-group-id="6254056008-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="4834514630-2">[</span><span class="p" data-group-id="4834514630-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="4834514630-3">}</span><span class="p" data-group-id="4834514630-2">]</span><span class="w">
</span><span class="p" data-group-id="4834514630-1">}</span><span class="w">

</span><span class="n">request</span><span class="p" data-group-id="6254056008-4">(</span><span class="n">request</span><span class="p" data-group-id="6254056008-4">)</span></code></pre>
</span><span class="n">request</span><span class="p" data-group-id="4834514630-4">(</span><span class="n">request</span><span class="p" data-group-id="4834514630-4">)</span></code></pre>
</section>
</section>
<section class="detail" id="request/5">
Expand Down Expand Up @@ -1919,7 +1919,7 @@ <h1 class="signature" translate="no">request(method, url, body \\ &quot;&quot;,
</a>
<span class="text">Examples</span>
</h2>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="p" data-group-id="2230824885-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="2230824885-2">[</span><span class="p" data-group-id="2230824885-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="2230824885-3">}</span><span class="p" data-group-id="2230824885-2">]</span><span class="p" data-group-id="2230824885-1">)</span></code></pre>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="p" data-group-id="2014425248-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="2014425248-2">[</span><span class="p" data-group-id="2014425248-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="2014425248-3">}</span><span class="p" data-group-id="2014425248-2">]</span><span class="p" data-group-id="2014425248-1">)</span></code></pre>
</section>
</section>
<section class="detail" id="request!/5">
Expand Down
2 changes: 1 addition & 1 deletion Lightning.CLI.Result.html
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ <h1>
<span class="text">Logs</span>
</h2>
<p>The OpenFn CLI returns JSON formatted log lines, which are decoded and added
to a <code class="inline">Result</code> struct.</p><p>There are two kinds of output:</p><pre><code class="makeup elixir" translate="no"><span class="p" data-group-id="0258050993-1">{</span><span class="s">&quot;level&quot;</span><span class="ss">:&quot;&lt;&lt;level&gt;&gt;&quot;</span><span class="p">,</span><span class="s">&quot;name&quot;</span><span class="ss">:&quot;&lt;&lt;module&gt;&gt;&quot;</span><span class="p">,</span><span class="s">&quot;message&quot;</span><span class="ss">:&quot;...&quot;</span><span class="p">]</span><span class="p">,</span><span class="s">&quot;time&quot;</span><span class="ss">:&lt;</span><span class="o">&lt;</span><span class="n">timestamp</span><span class="p">&gt;&gt;</span><span class="p" data-group-id="0258050993-1">}</span></code></pre><p>These are usually for general logging, and debugging.</p><pre><code class="makeup elixir" translate="no"><span class="p" data-group-id="5860433688-1">{</span><span class="s">&quot;message&quot;</span><span class="p">:</span><span class="p" data-group-id="5860433688-2">[</span><span class="s">&quot;&lt;&lt;message|filepath|output&gt;&gt;&quot;</span><span class="p" data-group-id="5860433688-2">]</span><span class="p" data-group-id="5860433688-1">}</span></code></pre><p>The above is the equivalent of the output of a command</p>
to a <code class="inline">Result</code> struct.</p><p>There are two kinds of output:</p><pre><code class="makeup elixir" translate="no"><span class="p" data-group-id="7838366616-1">{</span><span class="s">&quot;level&quot;</span><span class="ss">:&quot;&lt;&lt;level&gt;&gt;&quot;</span><span class="p">,</span><span class="s">&quot;name&quot;</span><span class="ss">:&quot;&lt;&lt;module&gt;&gt;&quot;</span><span class="p">,</span><span class="s">&quot;message&quot;</span><span class="ss">:&quot;...&quot;</span><span class="p">]</span><span class="p">,</span><span class="s">&quot;time&quot;</span><span class="ss">:&lt;</span><span class="o">&lt;</span><span class="n">timestamp</span><span class="p">&gt;&gt;</span><span class="p" data-group-id="7838366616-1">}</span></code></pre><p>These are usually for general logging, and debugging.</p><pre><code class="makeup elixir" translate="no"><span class="p" data-group-id="4141284076-1">{</span><span class="s">&quot;message&quot;</span><span class="p">:</span><span class="p" data-group-id="4141284076-2">[</span><span class="s">&quot;&lt;&lt;message|filepath|output&gt;&gt;&quot;</span><span class="p" data-group-id="4141284076-2">]</span><span class="p" data-group-id="4141284076-1">}</span></code></pre><p>The above is the equivalent of the output of a command</p>
</section>


Expand Down
Loading

0 comments on commit 8a3f317

Please sign in to comment.