Skip to content

Commit 09669fa

Browse files
author
Edgehog Bot
committed
Update Documentation
1 parent 146d851 commit 09669fa

22 files changed

Lines changed: 1398 additions & 1411 deletions

snapshot/Clea Edgehog.epub

10 Bytes
Binary file not shown.

snapshot/Edgehog.Actors.Actor.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -708,8 +708,8 @@ <h1 class="signature" translate="no">input(opts)</h1>
708708
be created by Ash as a result of a successful action. You should not be creating records manually in code,
709709
e.g <code class="inline">%MyResource{value: 1, value: 2}</code>. Generally that is fine, but often with embedded resources it is nice
710710
to be able to validate the keys that are being provided, e.g</p><pre><code class="makeup elixir" translate="no"><span class="nc">Resource</span><span class="w">
711-
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash.Changeset</span><span class="o">.</span><span class="n">for_create</span><span class="p" data-group-id="0023823056-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0023823056-2">%{</span><span class="ss">embedded</span><span class="p">:</span><span class="w"> </span><span class="nc">EmbeddedResource</span><span class="o">.</span><span class="n">input</span><span class="p" data-group-id="0023823056-3">(</span><span class="ss">foo</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="ss">bar</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p" data-group-id="0023823056-3">)</span><span class="p" data-group-id="0023823056-2">}</span><span class="p" data-group-id="0023823056-1">)</span><span class="w">
712-
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash</span><span class="o">.</span><span class="n">create</span><span class="p" data-group-id="0023823056-4">(</span><span class="p" data-group-id="0023823056-4">)</span></code></pre>
711+
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash.Changeset</span><span class="o">.</span><span class="n">for_create</span><span class="p" data-group-id="3982900008-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3982900008-2">%{</span><span class="ss">embedded</span><span class="p">:</span><span class="w"> </span><span class="nc">EmbeddedResource</span><span class="o">.</span><span class="n">input</span><span class="p" data-group-id="3982900008-3">(</span><span class="ss">foo</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="ss">bar</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p" data-group-id="3982900008-3">)</span><span class="p" data-group-id="3982900008-2">}</span><span class="p" data-group-id="3982900008-1">)</span><span class="w">
712+
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash</span><span class="o">.</span><span class="n">create</span><span class="p" data-group-id="3982900008-4">(</span><span class="p" data-group-id="3982900008-4">)</span></code></pre>
713713
</section>
714714
</section>
715715
<section class="detail" id="input/2">

snapshot/Edgehog.Auth.Policies.Filter.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h1>
118118

119119

120120
<section id="moduledoc">
121-
<p>An <a href="https://hexdocs.pm/ash/3.24.3/Ash.Policy.FilterCheck.html"><code class="inline">Ash.Policy.FilterCheck</code></a>, filtering the object of type <code class="inline">obj</code> available to the user <code class="inline">subj</code>.</p><p>To use it in a policy:</p><pre><code class="makeup elixir" translate="no"><span class="n">authorize_if</span><span class="w"> </span><span class="p" data-group-id="5207413375-1">{</span><span class="nc">Edgehog.Auth.Policies.Filter</span><span class="p">,</span><span class="w"> </span><span class="ss">rel</span><span class="p">:</span><span class="w"> </span><span class="ss">:can_view</span><span class="p">,</span><span class="w"> </span><span class="ss">obj</span><span class="p">:</span><span class="w"> </span><span class="ss">:device</span><span class="p" data-group-id="5207413375-1">}</span></code></pre>
121+
<p>An <a href="https://hexdocs.pm/ash/3.24.3/Ash.Policy.FilterCheck.html"><code class="inline">Ash.Policy.FilterCheck</code></a>, filtering the object of type <code class="inline">obj</code> available to the user <code class="inline">subj</code>.</p><p>To use it in a policy:</p><pre><code class="makeup elixir" translate="no"><span class="n">authorize_if</span><span class="w"> </span><span class="p" data-group-id="4339388465-1">{</span><span class="nc">Edgehog.Auth.Policies.Filter</span><span class="p">,</span><span class="w"> </span><span class="ss">rel</span><span class="p">:</span><span class="w"> </span><span class="ss">:can_view</span><span class="p">,</span><span class="w"> </span><span class="ss">obj</span><span class="p">:</span><span class="w"> </span><span class="ss">:device</span><span class="p" data-group-id="4339388465-1">}</span></code></pre>
122122
</section>
123123

124124
</div>

snapshot/Edgehog.Campaigns.CampaignMechanism.DeploymentDelete.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -704,8 +704,8 @@ <h1 class="signature" translate="no">input(opts)</h1>
704704
be created by Ash as a result of a successful action. You should not be creating records manually in code,
705705
e.g <code class="inline">%MyResource{value: 1, value: 2}</code>. Generally that is fine, but often with embedded resources it is nice
706706
to be able to validate the keys that are being provided, e.g</p><pre><code class="makeup elixir" translate="no"><span class="nc">Resource</span><span class="w">
707-
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash.Changeset</span><span class="o">.</span><span class="n">for_create</span><span class="p" data-group-id="6101192632-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6101192632-2">%{</span><span class="ss">embedded</span><span class="p">:</span><span class="w"> </span><span class="nc">EmbeddedResource</span><span class="o">.</span><span class="n">input</span><span class="p" data-group-id="6101192632-3">(</span><span class="ss">foo</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="ss">bar</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p" data-group-id="6101192632-3">)</span><span class="p" data-group-id="6101192632-2">}</span><span class="p" data-group-id="6101192632-1">)</span><span class="w">
708-
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash</span><span class="o">.</span><span class="n">create</span><span class="p" data-group-id="6101192632-4">(</span><span class="p" data-group-id="6101192632-4">)</span></code></pre>
707+
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash.Changeset</span><span class="o">.</span><span class="n">for_create</span><span class="p" data-group-id="1395753083-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1395753083-2">%{</span><span class="ss">embedded</span><span class="p">:</span><span class="w"> </span><span class="nc">EmbeddedResource</span><span class="o">.</span><span class="n">input</span><span class="p" data-group-id="1395753083-3">(</span><span class="ss">foo</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="ss">bar</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p" data-group-id="1395753083-3">)</span><span class="p" data-group-id="1395753083-2">}</span><span class="p" data-group-id="1395753083-1">)</span><span class="w">
708+
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash</span><span class="o">.</span><span class="n">create</span><span class="p" data-group-id="1395753083-4">(</span><span class="p" data-group-id="1395753083-4">)</span></code></pre>
709709
</section>
710710
</section>
711711
<section class="detail" id="input/2">

snapshot/Edgehog.Campaigns.CampaignMechanism.DeploymentDeploy.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -704,8 +704,8 @@ <h1 class="signature" translate="no">input(opts)</h1>
704704
be created by Ash as a result of a successful action. You should not be creating records manually in code,
705705
e.g <code class="inline">%MyResource{value: 1, value: 2}</code>. Generally that is fine, but often with embedded resources it is nice
706706
to be able to validate the keys that are being provided, e.g</p><pre><code class="makeup elixir" translate="no"><span class="nc">Resource</span><span class="w">
707-
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash.Changeset</span><span class="o">.</span><span class="n">for_create</span><span class="p" data-group-id="0745099484-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0745099484-2">%{</span><span class="ss">embedded</span><span class="p">:</span><span class="w"> </span><span class="nc">EmbeddedResource</span><span class="o">.</span><span class="n">input</span><span class="p" data-group-id="0745099484-3">(</span><span class="ss">foo</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="ss">bar</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p" data-group-id="0745099484-3">)</span><span class="p" data-group-id="0745099484-2">}</span><span class="p" data-group-id="0745099484-1">)</span><span class="w">
708-
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash</span><span class="o">.</span><span class="n">create</span><span class="p" data-group-id="0745099484-4">(</span><span class="p" data-group-id="0745099484-4">)</span></code></pre>
707+
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash.Changeset</span><span class="o">.</span><span class="n">for_create</span><span class="p" data-group-id="1096262644-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1096262644-2">%{</span><span class="ss">embedded</span><span class="p">:</span><span class="w"> </span><span class="nc">EmbeddedResource</span><span class="o">.</span><span class="n">input</span><span class="p" data-group-id="1096262644-3">(</span><span class="ss">foo</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="ss">bar</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p" data-group-id="1096262644-3">)</span><span class="p" data-group-id="1096262644-2">}</span><span class="p" data-group-id="1096262644-1">)</span><span class="w">
708+
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash</span><span class="o">.</span><span class="n">create</span><span class="p" data-group-id="1096262644-4">(</span><span class="p" data-group-id="1096262644-4">)</span></code></pre>
709709
</section>
710710
</section>
711711
<section class="detail" id="input/2">

snapshot/Edgehog.Campaigns.CampaignMechanism.DeploymentStart.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -704,8 +704,8 @@ <h1 class="signature" translate="no">input(opts)</h1>
704704
be created by Ash as a result of a successful action. You should not be creating records manually in code,
705705
e.g <code class="inline">%MyResource{value: 1, value: 2}</code>. Generally that is fine, but often with embedded resources it is nice
706706
to be able to validate the keys that are being provided, e.g</p><pre><code class="makeup elixir" translate="no"><span class="nc">Resource</span><span class="w">
707-
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash.Changeset</span><span class="o">.</span><span class="n">for_create</span><span class="p" data-group-id="1826610184-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1826610184-2">%{</span><span class="ss">embedded</span><span class="p">:</span><span class="w"> </span><span class="nc">EmbeddedResource</span><span class="o">.</span><span class="n">input</span><span class="p" data-group-id="1826610184-3">(</span><span class="ss">foo</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="ss">bar</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p" data-group-id="1826610184-3">)</span><span class="p" data-group-id="1826610184-2">}</span><span class="p" data-group-id="1826610184-1">)</span><span class="w">
708-
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash</span><span class="o">.</span><span class="n">create</span><span class="p" data-group-id="1826610184-4">(</span><span class="p" data-group-id="1826610184-4">)</span></code></pre>
707+
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash.Changeset</span><span class="o">.</span><span class="n">for_create</span><span class="p" data-group-id="5232246899-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5232246899-2">%{</span><span class="ss">embedded</span><span class="p">:</span><span class="w"> </span><span class="nc">EmbeddedResource</span><span class="o">.</span><span class="n">input</span><span class="p" data-group-id="5232246899-3">(</span><span class="ss">foo</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="ss">bar</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p" data-group-id="5232246899-3">)</span><span class="p" data-group-id="5232246899-2">}</span><span class="p" data-group-id="5232246899-1">)</span><span class="w">
708+
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash</span><span class="o">.</span><span class="n">create</span><span class="p" data-group-id="5232246899-4">(</span><span class="p" data-group-id="5232246899-4">)</span></code></pre>
709709
</section>
710710
</section>
711711
<section class="detail" id="input/2">

snapshot/Edgehog.Campaigns.CampaignMechanism.DeploymentStop.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -704,8 +704,8 @@ <h1 class="signature" translate="no">input(opts)</h1>
704704
be created by Ash as a result of a successful action. You should not be creating records manually in code,
705705
e.g <code class="inline">%MyResource{value: 1, value: 2}</code>. Generally that is fine, but often with embedded resources it is nice
706706
to be able to validate the keys that are being provided, e.g</p><pre><code class="makeup elixir" translate="no"><span class="nc">Resource</span><span class="w">
707-
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash.Changeset</span><span class="o">.</span><span class="n">for_create</span><span class="p" data-group-id="1856337807-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1856337807-2">%{</span><span class="ss">embedded</span><span class="p">:</span><span class="w"> </span><span class="nc">EmbeddedResource</span><span class="o">.</span><span class="n">input</span><span class="p" data-group-id="1856337807-3">(</span><span class="ss">foo</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="ss">bar</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p" data-group-id="1856337807-3">)</span><span class="p" data-group-id="1856337807-2">}</span><span class="p" data-group-id="1856337807-1">)</span><span class="w">
708-
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash</span><span class="o">.</span><span class="n">create</span><span class="p" data-group-id="1856337807-4">(</span><span class="p" data-group-id="1856337807-4">)</span></code></pre>
707+
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash.Changeset</span><span class="o">.</span><span class="n">for_create</span><span class="p" data-group-id="3579711488-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3579711488-2">%{</span><span class="ss">embedded</span><span class="p">:</span><span class="w"> </span><span class="nc">EmbeddedResource</span><span class="o">.</span><span class="n">input</span><span class="p" data-group-id="3579711488-3">(</span><span class="ss">foo</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="ss">bar</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p" data-group-id="3579711488-3">)</span><span class="p" data-group-id="3579711488-2">}</span><span class="p" data-group-id="3579711488-1">)</span><span class="w">
708+
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash</span><span class="o">.</span><span class="n">create</span><span class="p" data-group-id="3579711488-4">(</span><span class="p" data-group-id="3579711488-4">)</span></code></pre>
709709
</section>
710710
</section>
711711
<section class="detail" id="input/2">

snapshot/Edgehog.Campaigns.CampaignMechanism.DeploymentUpgrade.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -706,8 +706,8 @@ <h1 class="signature" translate="no">input(opts)</h1>
706706
be created by Ash as a result of a successful action. You should not be creating records manually in code,
707707
e.g <code class="inline">%MyResource{value: 1, value: 2}</code>. Generally that is fine, but often with embedded resources it is nice
708708
to be able to validate the keys that are being provided, e.g</p><pre><code class="makeup elixir" translate="no"><span class="nc">Resource</span><span class="w">
709-
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash.Changeset</span><span class="o">.</span><span class="n">for_create</span><span class="p" data-group-id="6921613036-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6921613036-2">%{</span><span class="ss">embedded</span><span class="p">:</span><span class="w"> </span><span class="nc">EmbeddedResource</span><span class="o">.</span><span class="n">input</span><span class="p" data-group-id="6921613036-3">(</span><span class="ss">foo</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="ss">bar</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p" data-group-id="6921613036-3">)</span><span class="p" data-group-id="6921613036-2">}</span><span class="p" data-group-id="6921613036-1">)</span><span class="w">
710-
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash</span><span class="o">.</span><span class="n">create</span><span class="p" data-group-id="6921613036-4">(</span><span class="p" data-group-id="6921613036-4">)</span></code></pre>
709+
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash.Changeset</span><span class="o">.</span><span class="n">for_create</span><span class="p" data-group-id="3040551373-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3040551373-2">%{</span><span class="ss">embedded</span><span class="p">:</span><span class="w"> </span><span class="nc">EmbeddedResource</span><span class="o">.</span><span class="n">input</span><span class="p" data-group-id="3040551373-3">(</span><span class="ss">foo</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="ss">bar</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p" data-group-id="3040551373-3">)</span><span class="p" data-group-id="3040551373-2">}</span><span class="p" data-group-id="3040551373-1">)</span><span class="w">
710+
</span><span class="o">|&gt;</span><span class="w"> </span><span class="nc">Ash</span><span class="o">.</span><span class="n">create</span><span class="p" data-group-id="3040551373-4">(</span><span class="p" data-group-id="3040551373-4">)</span></code></pre>
711711
</section>
712712
</section>
713713
<section class="detail" id="input/2">

0 commit comments

Comments
 (0)