Skip to content

Commit 131b30d

Browse files
author
Edgehog Bot
committed
Update Documentation
1 parent 1c83e1f commit 131b30d

22 files changed

Lines changed: 1341 additions & 1335 deletions

snapshot/Clea Edgehog.epub

1 Byte
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="6751834911-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6751834911-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="6751834911-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="6751834911-3">)</span><span class="p" data-group-id="6751834911-2">}</span><span class="p" data-group-id="6751834911-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="6751834911-4">(</span><span class="p" data-group-id="6751834911-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="3139848322-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3139848322-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="3139848322-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="3139848322-3">)</span><span class="p" data-group-id="3139848322-2">}</span><span class="p" data-group-id="3139848322-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="3139848322-4">(</span><span class="p" data-group-id="3139848322-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="3161030586-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="3161030586-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="2991981326-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="2991981326-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="3721702784-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3721702784-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="3721702784-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="3721702784-3">)</span><span class="p" data-group-id="3721702784-2">}</span><span class="p" data-group-id="3721702784-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="3721702784-4">(</span><span class="p" data-group-id="3721702784-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="4581582735-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4581582735-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="4581582735-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="4581582735-3">)</span><span class="p" data-group-id="4581582735-2">}</span><span class="p" data-group-id="4581582735-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="4581582735-4">(</span><span class="p" data-group-id="4581582735-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="5208400176-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5208400176-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="5208400176-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="5208400176-3">)</span><span class="p" data-group-id="5208400176-2">}</span><span class="p" data-group-id="5208400176-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="5208400176-4">(</span><span class="p" data-group-id="5208400176-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="4950384171-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4950384171-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="4950384171-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="4950384171-3">)</span><span class="p" data-group-id="4950384171-2">}</span><span class="p" data-group-id="4950384171-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="4950384171-4">(</span><span class="p" data-group-id="4950384171-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="7272607983-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="7272607983-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="7272607983-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="7272607983-3">)</span><span class="p" data-group-id="7272607983-2">}</span><span class="p" data-group-id="7272607983-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="7272607983-4">(</span><span class="p" data-group-id="7272607983-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="8821146822-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8821146822-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="8821146822-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="8821146822-3">)</span><span class="p" data-group-id="8821146822-2">}</span><span class="p" data-group-id="8821146822-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="8821146822-4">(</span><span class="p" data-group-id="8821146822-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="2588560888-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="2588560888-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="2588560888-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="2588560888-3">)</span><span class="p" data-group-id="2588560888-2">}</span><span class="p" data-group-id="2588560888-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="2588560888-4">(</span><span class="p" data-group-id="2588560888-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="5828218769-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5828218769-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="5828218769-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="5828218769-3">)</span><span class="p" data-group-id="5828218769-2">}</span><span class="p" data-group-id="5828218769-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="5828218769-4">(</span><span class="p" data-group-id="5828218769-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="3332651946-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3332651946-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="3332651946-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="3332651946-3">)</span><span class="p" data-group-id="3332651946-2">}</span><span class="p" data-group-id="3332651946-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="3332651946-4">(</span><span class="p" data-group-id="3332651946-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="8844002933-1">(</span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8844002933-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="8844002933-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="8844002933-3">)</span><span class="p" data-group-id="8844002933-2">}</span><span class="p" data-group-id="8844002933-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="8844002933-4">(</span><span class="p" data-group-id="8844002933-4">)</span></code></pre>
711711
</section>
712712
</section>
713713
<section class="detail" id="input/2">

0 commit comments

Comments
 (0)