Skip to content

Commit

Permalink
Deploying to gh-pages from @ 25babb5 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
stuartc committed Nov 6, 2024
1 parent 933e371 commit 460b197
Show file tree
Hide file tree
Showing 328 changed files with 1,406 additions and 1,033 deletions.
5 changes: 3 additions & 2 deletions .build
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ Lightning.Policies.Permissions.html
Lightning.Policies.ProjectUsers.html
Lightning.Policies.Provisioning.html
Lightning.Policies.Users.html
Lightning.Projects.Audit.html
Lightning.Projects.Events.html
Lightning.Projects.File.html
Lightning.Projects.Project.html
Expand Down Expand Up @@ -342,8 +343,8 @@ 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-78FC19D7.js
dist/sidebar_items-E266F003.js
dist/search_data-A5F1CE30.js
dist/sidebar_items-B6765C1A.js
index.html
provisioning.html
readme.html
Expand Down
2 changes: 1 addition & 1 deletion 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down
2 changes: 1 addition & 1 deletion Lightning.API.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down
2 changes: 1 addition & 1 deletion Lightning.Accounts.Events.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down
2 changes: 1 addition & 1 deletion Lightning.Accounts.User.RolesEnum.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down
2 changes: 1 addition & 1 deletion Lightning.Accounts.User.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down
2 changes: 1 addition & 1 deletion Lightning.Accounts.UserBackupCode.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down
2 changes: 1 addition & 1 deletion Lightning.Accounts.UserNotifier.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down
2 changes: 1 addition & 1 deletion Lightning.Accounts.UserTOTP.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down
2 changes: 1 addition & 1 deletion Lightning.Accounts.UserToken.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down
144 changes: 72 additions & 72 deletions Lightning.Accounts.html

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions Lightning.AdaptorRegistry.Npm.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down Expand Up @@ -1690,14 +1690,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="9668203944-1">%</span><span class="nc" data-group-id="9668203944-1">HTTPoison.Request</span><span class="p" data-group-id="9668203944-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="4346504097-1">%</span><span class="nc" data-group-id="4346504097-1">HTTPoison.Request</span><span class="p" data-group-id="4346504097-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="9668203944-2">[</span><span class="p" data-group-id="9668203944-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="9668203944-3">}</span><span class="p" data-group-id="9668203944-2">]</span><span class="w">
</span><span class="p" data-group-id="9668203944-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="4346504097-2">[</span><span class="p" data-group-id="4346504097-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="4346504097-3">}</span><span class="p" data-group-id="4346504097-2">]</span><span class="w">
</span><span class="p" data-group-id="4346504097-1">}</span><span class="w">

</span><span class="n">request</span><span class="p" data-group-id="9668203944-4">(</span><span class="n">request</span><span class="p" data-group-id="9668203944-4">)</span></code></pre>
</span><span class="n">request</span><span class="p" data-group-id="4346504097-4">(</span><span class="n">request</span><span class="p" data-group-id="4346504097-4">)</span></code></pre>
</section>
</section>
<section class="detail" id="request/5">
Expand Down Expand Up @@ -1755,7 +1755,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="9270299648-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="9270299648-2">[</span><span class="p" data-group-id="9270299648-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="9270299648-3">}</span><span class="p" data-group-id="9270299648-2">]</span><span class="p" data-group-id="9270299648-1">)</span></code></pre>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="p" data-group-id="2945394958-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="2945394958-2">[</span><span class="p" data-group-id="2945394958-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="2945394958-3">}</span><span class="p" data-group-id="2945394958-2">]</span><span class="p" data-group-id="2945394958-1">)</span></code></pre>
</section>
</section>
<section class="detail" id="request!/1">
Expand Down
14 changes: 7 additions & 7 deletions Lightning.AdaptorRegistry.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down 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="6911199539-1">(</span><span class="p" data-group-id="6911199539-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="9548898815-1">(</span><span class="p" data-group-id="9548898815-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="6911199539-2">(</span><span class="p" data-group-id="6911199539-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="9548898815-2">(</span><span class="p" data-group-id="9548898815-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="2111259608-1">(</span><span class="s">&quot;@openfn/language-salesforce@1.2.3&quot;</span><span class="p" data-group-id="2111259608-1">)</span><span class="w">
</span><span class="p" data-group-id="2111259608-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="2111259608-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="2111259608-3">(</span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p" data-group-id="2111259608-3">)</span><span class="w">
</span><span class="p" data-group-id="2111259608-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="2111259608-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="4003020889-1">(</span><span class="s">&quot;@openfn/language-salesforce@1.2.3&quot;</span><span class="p" data-group-id="4003020889-1">)</span><span class="w">
</span><span class="p" data-group-id="4003020889-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="4003020889-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="4003020889-3">(</span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p" data-group-id="4003020889-3">)</span><span class="w">
</span><span class="p" data-group-id="4003020889-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="4003020889-4">}</span></code></pre>
</section>
</section>
<section class="detail" id="resolve_package_name!/1">
Expand Down
2 changes: 1 addition & 1 deletion Lightning.AdaptorService.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down
2 changes: 1 addition & 1 deletion Lightning.AiAssistant.Limiter.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions Lightning.AiAssistant.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down Expand Up @@ -508,8 +508,8 @@ <h1 class="signature" translate="no">query(session, content)</h1>

</div>

<p>Queries the AI assistant with the given content.</p><p>Returns <code class="inline">{:ok, session}</code> if the query was successful, otherwise <code class="inline">:error</code>.</p><p><strong>Example</strong></p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="nc">AiAssistant</span><span class="o">.</span><span class="n">query</span><span class="p" data-group-id="7238135592-1">(</span><span class="n">session</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;fn()&quot;</span><span class="p" data-group-id="7238135592-1">)</span><span class="w">
</span><span class="p" data-group-id="7238135592-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="n">session</span><span class="p" data-group-id="7238135592-2">}</span></code></pre>
<p>Queries the AI assistant with the given content.</p><p>Returns <code class="inline">{:ok, session}</code> if the query was successful, otherwise <code class="inline">:error</code>.</p><p><strong>Example</strong></p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="nc">AiAssistant</span><span class="o">.</span><span class="n">query</span><span class="p" data-group-id="3715372141-1">(</span><span class="n">session</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;fn()&quot;</span><span class="p" data-group-id="3715372141-1">)</span><span class="w">
</span><span class="p" data-group-id="3715372141-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="n">session</span><span class="p" data-group-id="3715372141-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="save_message/2">
Expand Down
2 changes: 1 addition & 1 deletion Lightning.ApolloClient.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down
12 changes: 7 additions & 5 deletions Lightning.Auditing.Audit.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-EPF2X7PV.js"></script>
<script src="dist/sidebar_items-E266F003.js"></script>
<script src="dist/sidebar_items-B6765C1A.js"></script>

<script src="docs_config.js"></script>

Expand Down Expand Up @@ -159,6 +159,8 @@ <h2>

</div>

<div class="summary-synopsis"><p>Callback to update changes before saving to the database.</p></div>

</div>

</div>
Expand Down Expand Up @@ -210,7 +212,7 @@ <h1 class="section-heading">
</a>
<h1 class="signature" translate="no">update_changes(changes)</h1>

<a href="https://github.com/OpenFn/lightning/blob/main/lib/lightning/auditing/audit.ex#L10" class="icon-action" rel="help" title="View Source">
<a href="https://github.com/OpenFn/lightning/blob/main/lib/lightning/auditing/audit.ex#L13" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
Expand All @@ -226,7 +228,7 @@ <h1 class="signature" translate="no">update_changes(changes)</h1>

</div>


<p>Callback to update changes before saving to the database.</p>
</section>
</section>

Expand Down Expand Up @@ -254,7 +256,7 @@ <h1 class="section-heading">
</a>
<h1 class="signature" translate="no">event(item_type, event, item_id, actor_id, changes \\ %{}, update_fun \\ fn x -&gt; x end)</h1>

<a href="https://github.com/OpenFn/lightning/blob/main/lib/lightning/auditing/audit.ex#L179" class="icon-action" rel="help" title="View Source">
<a href="https://github.com/OpenFn/lightning/blob/main/lib/lightning/auditing/audit.ex#L182" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
Expand Down Expand Up @@ -291,7 +293,7 @@ <h1 class="signature" translate="no">event(item_type, event, item_id, actor_id,
</a>
<h1 class="signature" translate="no">save(changes, repo)</h1>

<a href="https://github.com/OpenFn/lightning/blob/main/lib/lightning/auditing/audit.ex#L151" class="icon-action" rel="help" title="View Source">
<a href="https://github.com/OpenFn/lightning/blob/main/lib/lightning/auditing/audit.ex#L154" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
Expand Down
Loading

0 comments on commit 460b197

Please sign in to comment.