mirror of
https://github.com/bonfire-networks/bonfire-app.git
synced 2024-05-17 08:32:41 +00:00
1032 lines
78 KiB
HTML
1032 lines
78 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="generator" content="ExDoc v0.31.2">
|
|
<meta name="project" content="bonfire_umbrella v0.9.10-cooperation-beta.62">
|
|
|
|
|
|
<title>ActivityPub.Federator.HTTP.Tesla — bonfire_umbrella v0.9.10-cooperation-beta.62</title>
|
|
<link rel="stylesheet" href="dist/html-elixir-JKHCEBPC.css" />
|
|
|
|
|
|
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
|
|
<script src="dist/handlebars.templates-A7S2WMC7.js"></script>
|
|
<script src="dist/sidebar_items-0AD831F9.js"></script>
|
|
|
|
<script src="docs_config.js"></script>
|
|
|
|
<script async src="dist/html-JRPQ5PR6.js"></script>
|
|
|
|
|
|
</head>
|
|
<body data-type="modules" class="page-module">
|
|
<script>
|
|
|
|
try {
|
|
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
|
|
|
|
if (settings.theme === 'dark' ||
|
|
((settings.theme === 'system' || settings.theme == null) &&
|
|
window.matchMedia('(prefers-color-scheme: dark)').matches)
|
|
) {
|
|
document.body.classList.add('dark')
|
|
}
|
|
} catch (error) { }
|
|
</script>
|
|
|
|
<div class="main">
|
|
|
|
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
|
|
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
|
|
</button>
|
|
|
|
<div class="background-layer"></div>
|
|
|
|
<nav id="sidebar" class="sidebar">
|
|
|
|
<div class="sidebar-header">
|
|
<div class="sidebar-projectInfo">
|
|
|
|
<a href="https://bonfirenetworks.org" class="sidebar-projectImage">
|
|
<img src="assets/logo.png" alt="bonfire_umbrella" />
|
|
</a>
|
|
|
|
<div>
|
|
<a href="https://bonfirenetworks.org" class="sidebar-projectName" translate="no">
|
|
bonfire_umbrella
|
|
</a>
|
|
<div class="sidebar-projectVersion" translate="no">
|
|
v0.9.10-cooperation-beta.62
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">
|
|
<li>
|
|
<button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">
|
|
Pages
|
|
</button>
|
|
</li>
|
|
|
|
<li>
|
|
<button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">
|
|
Modules
|
|
</button>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">
|
|
<ul id="extras-full-list" class="full-list"></ul>
|
|
</div>
|
|
|
|
<div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>
|
|
<ul id="modules-full-list" class="full-list"></ul>
|
|
</div>
|
|
|
|
|
|
</nav>
|
|
|
|
<main class="content">
|
|
<output role="status" id="toast"></output>
|
|
<div class="content-outer">
|
|
<div id="content" class="content-inner">
|
|
<div class="top-search">
|
|
<div class="search-settings">
|
|
<form class="search-bar" action="search.html">
|
|
<label class="search-label">
|
|
<span class="sr-only">Search documentation of bonfire_umbrella</span>
|
|
<input name="q" type="text" class="search-input" placeholder="Press / to search" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
|
|
</label>
|
|
<button type="submit" class="search-button" aria-label="Submit Search">
|
|
<i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>
|
|
</button>
|
|
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
|
|
<i class="ri-close-line ri-lg" title="Cancel search"></i>
|
|
</button>
|
|
</form>
|
|
<div class="autocomplete">
|
|
</div>
|
|
<button class="icon-settings display-settings">
|
|
<i class="ri-settings-3-line"></i>
|
|
<span class="sr-only">Settings</span>
|
|
</button>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L1" title="View Source" class="icon-action" rel="help">
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
<span class="sr-only">View Source</span>
|
|
</a>
|
|
|
|
<span translate="no">ActivityPub.Federator.HTTP.Tesla</span>
|
|
<small class="app-vsn" translate="no">(bonfire_umbrella v0.9.10-cooperation-beta.62)</small>
|
|
|
|
</h1>
|
|
|
|
|
|
|
|
<section id="summary" class="details-list">
|
|
<h1 class="section-heading">
|
|
<a class="hover-link" href="#summary">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
</a>
|
|
<span class="text">Summary</span>
|
|
</h1>
|
|
<div class="summary-types summary">
|
|
<h2>
|
|
<a href="#types">Types</a>
|
|
</h2>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#t:option/0" translate="no">option()</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Options that may be passed to a request function. See <a href="#request/2"><code class="inline">request/2</code></a> for detailed descriptions.</p></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="summary-functions summary">
|
|
<h2>
|
|
<a href="#functions">Functions</a>
|
|
</h2>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#delete/3" translate="no">delete(client, url, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a DELETE request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#delete!/3" translate="no">delete!(client, url, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a DELETE request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#get/3" translate="no">get(client, url, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a GET request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#get!/3" translate="no">get!(client, url, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a GET request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#head/3" translate="no">head(client, url, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a HEAD request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#head!/3" translate="no">head!(client, url, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a HEAD request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#options/3" translate="no">options(client, url, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a OPTIONS request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#options!/3" translate="no">options!(client, url, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a OPTIONS request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#patch/4" translate="no">patch(client, url, body, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a PATCH request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#patch!/4" translate="no">patch!(client, url, body, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a PATCH request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#post/4" translate="no">post(client, url, body, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a POST request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#post!/4" translate="no">post!(client, url, body, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a POST request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#put/4" translate="no">put(client, url, body, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a PUT request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#put!/4" translate="no">put!(client, url, body, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a PUT request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#request/2" translate="no">request(client \\ %Tesla.Client{}, options)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#request!/2" translate="no">request!(client \\ %Tesla.Client{}, options)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform request and raise in case of error.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#trace/3" translate="no">trace(client, url, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a TRACE request.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#trace!/3" translate="no">trace!(client, url, opts)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Perform a TRACE request.</p></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</section>
|
|
|
|
|
|
<section id="types" class="details-list">
|
|
<h1 class="section-heading">
|
|
<a class="hover-link" href="#types">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
</a>
|
|
<span class="text">Types</span>
|
|
</h1>
|
|
<div class="types-list">
|
|
<section class="detail" id="t:option/0">
|
|
|
|
<div class="detail-header">
|
|
<a href="#t:option/0" class="detail-link" title="Link to this type">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this type</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">option()</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@type</span> option() ::
|
|
{:method, <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:method/0">Tesla.Env.method</a>()}
|
|
| {:url, <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>()}
|
|
| {:query, <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:query/0">Tesla.Env.query</a>()}
|
|
| {:headers, <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:headers/0">Tesla.Env.headers</a>()}
|
|
| {:body, <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:body/0">Tesla.Env.body</a>()}
|
|
| {:opts, <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:opts/0">Tesla.Env.opts</a>()}</pre>
|
|
|
|
</div>
|
|
|
|
<p>Options that may be passed to a request function. See <a href="#request/2"><code class="inline">request/2</code></a> for detailed descriptions.</p>
|
|
</section>
|
|
</section>
|
|
|
|
</div>
|
|
</section>
|
|
|
|
<section id="functions" class="details-list">
|
|
<h1 class="section-heading">
|
|
<a class="hover-link" href="#functions">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
</a>
|
|
<span class="text">Functions</span>
|
|
</h1>
|
|
<div class="functions-list">
|
|
<section class="detail" id="delete/3">
|
|
|
|
<div class="detail-header">
|
|
<a href="#delete/3" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">delete(client, url, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> delete(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) :: <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a DELETE request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">delete</span><span class="p" data-group-id="3186686389-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="3186686389-1">)</span><span class="w">
|
|
</span><span class="n">delete</span><span class="p" data-group-id="3186686389-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3186686389-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="3186686389-3">]</span><span class="p" data-group-id="3186686389-2">)</span><span class="w">
|
|
</span><span class="n">delete</span><span class="p" data-group-id="3186686389-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="3186686389-4">)</span><span class="w">
|
|
</span><span class="n">delete</span><span class="p" data-group-id="3186686389-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3186686389-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="3186686389-6">]</span><span class="p" data-group-id="3186686389-5">)</span><span class="w">
|
|
</span><span class="n">delete</span><span class="p" data-group-id="3186686389-7">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3186686389-8">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="3186686389-8">}</span><span class="p" data-group-id="3186686389-7">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="delete!/3">
|
|
|
|
<div class="detail-header">
|
|
<a href="#delete!/3" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">delete!(client, url, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> delete!(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) ::
|
|
<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a DELETE request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">delete!</span><span class="p" data-group-id="6118319995-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="6118319995-1">)</span><span class="w">
|
|
</span><span class="n">delete!</span><span class="p" data-group-id="6118319995-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="6118319995-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="6118319995-3">]</span><span class="p" data-group-id="6118319995-2">)</span><span class="w">
|
|
</span><span class="n">delete!</span><span class="p" data-group-id="6118319995-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="6118319995-4">)</span><span class="w">
|
|
</span><span class="n">delete!</span><span class="p" data-group-id="6118319995-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="6118319995-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="6118319995-6">]</span><span class="p" data-group-id="6118319995-5">)</span><span class="w">
|
|
</span><span class="n">delete!</span><span class="p" data-group-id="6118319995-7">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="6118319995-8">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="6118319995-8">}</span><span class="p" data-group-id="6118319995-7">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="get/3">
|
|
|
|
<div class="detail-header">
|
|
<a href="#get/3" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">get(client, url, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> get(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) :: <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a GET request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">get</span><span class="p" data-group-id="0291418973-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="0291418973-1">)</span><span class="w">
|
|
</span><span class="n">get</span><span class="p" data-group-id="0291418973-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0291418973-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="0291418973-3">]</span><span class="p" data-group-id="0291418973-2">)</span><span class="w">
|
|
</span><span class="n">get</span><span class="p" data-group-id="0291418973-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="0291418973-4">)</span><span class="w">
|
|
</span><span class="n">get</span><span class="p" data-group-id="0291418973-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0291418973-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="0291418973-6">]</span><span class="p" data-group-id="0291418973-5">)</span><span class="w">
|
|
</span><span class="n">get</span><span class="p" data-group-id="0291418973-7">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0291418973-8">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="0291418973-8">}</span><span class="p" data-group-id="0291418973-7">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="get!/3">
|
|
|
|
<div class="detail-header">
|
|
<a href="#get!/3" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">get!(client, url, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> get!(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) ::
|
|
<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a GET request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">get!</span><span class="p" data-group-id="4777531006-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="4777531006-1">)</span><span class="w">
|
|
</span><span class="n">get!</span><span class="p" data-group-id="4777531006-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="4777531006-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="4777531006-3">]</span><span class="p" data-group-id="4777531006-2">)</span><span class="w">
|
|
</span><span class="n">get!</span><span class="p" data-group-id="4777531006-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="4777531006-4">)</span><span class="w">
|
|
</span><span class="n">get!</span><span class="p" data-group-id="4777531006-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="4777531006-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="4777531006-6">]</span><span class="p" data-group-id="4777531006-5">)</span><span class="w">
|
|
</span><span class="n">get!</span><span class="p" data-group-id="4777531006-7">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="4777531006-8">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="4777531006-8">}</span><span class="p" data-group-id="4777531006-7">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="head/3">
|
|
|
|
<div class="detail-header">
|
|
<a href="#head/3" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">head(client, url, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> head(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) :: <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a HEAD request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">head</span><span class="p" data-group-id="0582085769-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="0582085769-1">)</span><span class="w">
|
|
</span><span class="n">head</span><span class="p" data-group-id="0582085769-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0582085769-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="0582085769-3">]</span><span class="p" data-group-id="0582085769-2">)</span><span class="w">
|
|
</span><span class="n">head</span><span class="p" data-group-id="0582085769-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="0582085769-4">)</span><span class="w">
|
|
</span><span class="n">head</span><span class="p" data-group-id="0582085769-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0582085769-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="0582085769-6">]</span><span class="p" data-group-id="0582085769-5">)</span><span class="w">
|
|
</span><span class="n">head</span><span class="p" data-group-id="0582085769-7">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0582085769-8">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="0582085769-8">}</span><span class="p" data-group-id="0582085769-7">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="head!/3">
|
|
|
|
<div class="detail-header">
|
|
<a href="#head!/3" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">head!(client, url, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> head!(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) ::
|
|
<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a HEAD request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">head!</span><span class="p" data-group-id="1981150951-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="1981150951-1">)</span><span class="w">
|
|
</span><span class="n">head!</span><span class="p" data-group-id="1981150951-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="1981150951-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="1981150951-3">]</span><span class="p" data-group-id="1981150951-2">)</span><span class="w">
|
|
</span><span class="n">head!</span><span class="p" data-group-id="1981150951-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="1981150951-4">)</span><span class="w">
|
|
</span><span class="n">head!</span><span class="p" data-group-id="1981150951-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="1981150951-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="1981150951-6">]</span><span class="p" data-group-id="1981150951-5">)</span><span class="w">
|
|
</span><span class="n">head!</span><span class="p" data-group-id="1981150951-7">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="1981150951-8">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="1981150951-8">}</span><span class="p" data-group-id="1981150951-7">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="options/3">
|
|
|
|
<div class="detail-header">
|
|
<a href="#options/3" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">options(client, url, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> options(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) :: <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a OPTIONS request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">options</span><span class="p" data-group-id="0307957516-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="0307957516-1">)</span><span class="w">
|
|
</span><span class="n">options</span><span class="p" data-group-id="0307957516-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0307957516-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="0307957516-3">]</span><span class="p" data-group-id="0307957516-2">)</span><span class="w">
|
|
</span><span class="n">options</span><span class="p" data-group-id="0307957516-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="0307957516-4">)</span><span class="w">
|
|
</span><span class="n">options</span><span class="p" data-group-id="0307957516-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0307957516-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="0307957516-6">]</span><span class="p" data-group-id="0307957516-5">)</span><span class="w">
|
|
</span><span class="n">options</span><span class="p" data-group-id="0307957516-7">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0307957516-8">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="0307957516-8">}</span><span class="p" data-group-id="0307957516-7">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="options!/3">
|
|
|
|
<div class="detail-header">
|
|
<a href="#options!/3" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">options!(client, url, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> options!(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) ::
|
|
<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a OPTIONS request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">options!</span><span class="p" data-group-id="3026013540-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="3026013540-1">)</span><span class="w">
|
|
</span><span class="n">options!</span><span class="p" data-group-id="3026013540-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3026013540-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="3026013540-3">]</span><span class="p" data-group-id="3026013540-2">)</span><span class="w">
|
|
</span><span class="n">options!</span><span class="p" data-group-id="3026013540-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="3026013540-4">)</span><span class="w">
|
|
</span><span class="n">options!</span><span class="p" data-group-id="3026013540-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3026013540-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="3026013540-6">]</span><span class="p" data-group-id="3026013540-5">)</span><span class="w">
|
|
</span><span class="n">options!</span><span class="p" data-group-id="3026013540-7">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3026013540-8">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="3026013540-8">}</span><span class="p" data-group-id="3026013540-7">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="patch/4">
|
|
|
|
<div class="detail-header">
|
|
<a href="#patch/4" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">patch(client, url, body, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> patch(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:body/0">Tesla.Env.body</a>(), [<a href="#t:option/0">option</a>()]) ::
|
|
<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a PATCH request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">patch</span><span class="p" data-group-id="9890508461-1">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9890508461-2">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="9890508461-2">}</span><span class="p" data-group-id="9890508461-1">)</span><span class="w">
|
|
</span><span class="n">patch</span><span class="p" data-group-id="9890508461-3">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9890508461-4">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="9890508461-4">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9890508461-5">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="9890508461-5">]</span><span class="p" data-group-id="9890508461-3">)</span><span class="w">
|
|
</span><span class="n">patch</span><span class="p" data-group-id="9890508461-6">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9890508461-7">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="9890508461-7">}</span><span class="p" data-group-id="9890508461-6">)</span><span class="w">
|
|
</span><span class="n">patch</span><span class="p" data-group-id="9890508461-8">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9890508461-9">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="9890508461-9">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9890508461-10">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="9890508461-10">]</span><span class="p" data-group-id="9890508461-8">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="patch!/4">
|
|
|
|
<div class="detail-header">
|
|
<a href="#patch!/4" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">patch!(client, url, body, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> patch!(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:body/0">Tesla.Env.body</a>(), [<a href="#t:option/0">option</a>()]) ::
|
|
<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a PATCH request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">patch!</span><span class="p" data-group-id="8108312707-1">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8108312707-2">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="8108312707-2">}</span><span class="p" data-group-id="8108312707-1">)</span><span class="w">
|
|
</span><span class="n">patch!</span><span class="p" data-group-id="8108312707-3">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8108312707-4">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="8108312707-4">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="8108312707-5">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="8108312707-5">]</span><span class="p" data-group-id="8108312707-3">)</span><span class="w">
|
|
</span><span class="n">patch!</span><span class="p" data-group-id="8108312707-6">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8108312707-7">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="8108312707-7">}</span><span class="p" data-group-id="8108312707-6">)</span><span class="w">
|
|
</span><span class="n">patch!</span><span class="p" data-group-id="8108312707-8">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8108312707-9">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="8108312707-9">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="8108312707-10">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="8108312707-10">]</span><span class="p" data-group-id="8108312707-8">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="post/4">
|
|
|
|
<div class="detail-header">
|
|
<a href="#post/4" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">post(client, url, body, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> post(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:body/0">Tesla.Env.body</a>(), [<a href="#t:option/0">option</a>()]) ::
|
|
<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a POST request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">post</span><span class="p" data-group-id="6181858071-1">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6181858071-2">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="6181858071-2">}</span><span class="p" data-group-id="6181858071-1">)</span><span class="w">
|
|
</span><span class="n">post</span><span class="p" data-group-id="6181858071-3">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6181858071-4">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="6181858071-4">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="6181858071-5">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="6181858071-5">]</span><span class="p" data-group-id="6181858071-3">)</span><span class="w">
|
|
</span><span class="n">post</span><span class="p" data-group-id="6181858071-6">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6181858071-7">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="6181858071-7">}</span><span class="p" data-group-id="6181858071-6">)</span><span class="w">
|
|
</span><span class="n">post</span><span class="p" data-group-id="6181858071-8">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6181858071-9">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="6181858071-9">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="6181858071-10">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="6181858071-10">]</span><span class="p" data-group-id="6181858071-8">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="post!/4">
|
|
|
|
<div class="detail-header">
|
|
<a href="#post!/4" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">post!(client, url, body, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> post!(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:body/0">Tesla.Env.body</a>(), [<a href="#t:option/0">option</a>()]) ::
|
|
<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a POST request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">post!</span><span class="p" data-group-id="6918711605-1">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6918711605-2">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="6918711605-2">}</span><span class="p" data-group-id="6918711605-1">)</span><span class="w">
|
|
</span><span class="n">post!</span><span class="p" data-group-id="6918711605-3">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6918711605-4">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="6918711605-4">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="6918711605-5">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="6918711605-5">]</span><span class="p" data-group-id="6918711605-3">)</span><span class="w">
|
|
</span><span class="n">post!</span><span class="p" data-group-id="6918711605-6">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6918711605-7">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="6918711605-7">}</span><span class="p" data-group-id="6918711605-6">)</span><span class="w">
|
|
</span><span class="n">post!</span><span class="p" data-group-id="6918711605-8">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6918711605-9">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="6918711605-9">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="6918711605-10">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="6918711605-10">]</span><span class="p" data-group-id="6918711605-8">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="put/4">
|
|
|
|
<div class="detail-header">
|
|
<a href="#put/4" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">put(client, url, body, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> put(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:body/0">Tesla.Env.body</a>(), [<a href="#t:option/0">option</a>()]) ::
|
|
<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a PUT request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">put</span><span class="p" data-group-id="1781917490-1">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1781917490-2">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="1781917490-2">}</span><span class="p" data-group-id="1781917490-1">)</span><span class="w">
|
|
</span><span class="n">put</span><span class="p" data-group-id="1781917490-3">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1781917490-4">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="1781917490-4">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="1781917490-5">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="1781917490-5">]</span><span class="p" data-group-id="1781917490-3">)</span><span class="w">
|
|
</span><span class="n">put</span><span class="p" data-group-id="1781917490-6">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1781917490-7">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="1781917490-7">}</span><span class="p" data-group-id="1781917490-6">)</span><span class="w">
|
|
</span><span class="n">put</span><span class="p" data-group-id="1781917490-8">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1781917490-9">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="1781917490-9">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="1781917490-10">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="1781917490-10">]</span><span class="p" data-group-id="1781917490-8">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="put!/4">
|
|
|
|
<div class="detail-header">
|
|
<a href="#put!/4" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">put!(client, url, body, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> put!(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:body/0">Tesla.Env.body</a>(), [<a href="#t:option/0">option</a>()]) ::
|
|
<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a PUT request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">put!</span><span class="p" data-group-id="5970170280-1">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5970170280-2">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="5970170280-2">}</span><span class="p" data-group-id="5970170280-1">)</span><span class="w">
|
|
</span><span class="n">put!</span><span class="p" data-group-id="5970170280-3">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5970170280-4">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="5970170280-4">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5970170280-5">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="5970170280-5">]</span><span class="p" data-group-id="5970170280-3">)</span><span class="w">
|
|
</span><span class="n">put!</span><span class="p" data-group-id="5970170280-6">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5970170280-7">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="5970170280-7">}</span><span class="p" data-group-id="5970170280-6">)</span><span class="w">
|
|
</span><span class="n">put!</span><span class="p" data-group-id="5970170280-8">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5970170280-9">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="5970170280-9">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5970170280-10">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="5970170280-10">]</span><span class="p" data-group-id="5970170280-8">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="request/2">
|
|
|
|
<span id="request/1"></span>
|
|
|
|
<div class="detail-header">
|
|
<a href="#request/2" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">request(client \\ %Tesla.Client{}, options)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> request(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), [<a href="#t:option/0">option</a>()]) :: <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a request.</p><h2 id="request/2-options" class="section-heading">
|
|
<a href="#request/2-options" class="hover-link">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
</a>
|
|
<span class="text">Options</span>
|
|
</h2>
|
|
<ul><li><code class="inline">:method</code> - the request method, one of [<code class="inline">:head</code>, <code class="inline">:get</code>, <code class="inline">:delete</code>, <code class="inline">:trace</code>, <code class="inline">:options</code>, <code class="inline">:post</code>, <code class="inline">:put</code>, <code class="inline">:patch</code>]</li><li><code class="inline">:url</code> - either full url e.g. "<a href="http://example.com/some/path%22">http://example.com/some/path"</a> or just "/some/path" if using <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Middleware.BaseUrl.html"><code class="inline">Tesla.Middleware.BaseUrl</code></a></li><li><code class="inline">:query</code> - a keyword list of query params, e.g. <code class="inline">[page: 1, per_page: 100]</code></li><li><code class="inline">:headers</code> - a keyworld list of headers, e.g. <code class="inline">[{"content-type", "text/plain"}]</code></li><li><code class="inline">:body</code> - depends on used middleware:<ul><li>by default it can be a binary</li><li>if using e.g. JSON encoding middleware it can be a nested map</li><li>if adapter supports it it can be a Stream with any of the above</li></ul></li><li><code class="inline">:opts</code> - custom, per-request middleware or adapter options</li></ul><h2 id="request/2-examples" class="section-heading">
|
|
<a href="#request/2-examples" class="hover-link">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
</a>
|
|
<span class="text">Examples</span>
|
|
</h2>
|
|
<pre><code class="makeup elixir" translate="no"><span class="nc">ExampleApi</span><span class="o">.</span><span class="n">request</span><span class="p" data-group-id="4534623411-1">(</span><span class="ss">method</span><span class="p">:</span><span class="w"> </span><span class="ss">:get</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">"/users/path"</span><span class="p" data-group-id="4534623411-1">)</span><span class="w">
|
|
|
|
</span><span class="c1"># use shortcut methods</span><span class="w">
|
|
</span><span class="nc">ExampleApi</span><span class="o">.</span><span class="n">get</span><span class="p" data-group-id="4534623411-2">(</span><span class="s">"/users/1"</span><span class="p" data-group-id="4534623411-2">)</span><span class="w">
|
|
</span><span class="nc">ExampleApi</span><span class="o">.</span><span class="n">post</span><span class="p" data-group-id="4534623411-3">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4534623411-4">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="4534623411-4">}</span><span class="p" data-group-id="4534623411-3">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="request!/2">
|
|
|
|
<span id="request!/1"></span>
|
|
|
|
<div class="detail-header">
|
|
<a href="#request!/2" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">request!(client \\ %Tesla.Client{}, options)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> request!(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), [<a href="#t:option/0">option</a>()]) :: <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform request and raise in case of error.</p><p>This is similar to <a href="#request/2"><code class="inline">request/2</code></a> behaviour from Tesla 0.x</p><p>See <a href="#request/2"><code class="inline">request/2</code></a> for list of available options.</p>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="trace/3">
|
|
|
|
<div class="detail-header">
|
|
<a href="#trace/3" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">trace(client, url, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> trace(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) :: <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a TRACE request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">trace</span><span class="p" data-group-id="9233401452-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="9233401452-1">)</span><span class="w">
|
|
</span><span class="n">trace</span><span class="p" data-group-id="9233401452-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9233401452-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="9233401452-3">]</span><span class="p" data-group-id="9233401452-2">)</span><span class="w">
|
|
</span><span class="n">trace</span><span class="p" data-group-id="9233401452-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="9233401452-4">)</span><span class="w">
|
|
</span><span class="n">trace</span><span class="p" data-group-id="9233401452-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9233401452-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="9233401452-6">]</span><span class="p" data-group-id="9233401452-5">)</span><span class="w">
|
|
</span><span class="n">trace</span><span class="p" data-group-id="9233401452-7">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9233401452-8">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="9233401452-8">}</span><span class="p" data-group-id="9233401452-7">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="trace!/3">
|
|
|
|
<div class="detail-header">
|
|
<a href="#trace!/3" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">trace!(client, url, opts)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/federator/http/tesla.ex#L2" 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>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> trace!(<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) ::
|
|
<a href="https://hexdocs.pm/tesla/1.9.0/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
|
|
|
|
</div>
|
|
|
|
<p>Perform a TRACE request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir" translate="no"><span class="n">trace!</span><span class="p" data-group-id="3370716401-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="3370716401-1">)</span><span class="w">
|
|
</span><span class="n">trace!</span><span class="p" data-group-id="3370716401-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3370716401-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="3370716401-3">]</span><span class="p" data-group-id="3370716401-2">)</span><span class="w">
|
|
</span><span class="n">trace!</span><span class="p" data-group-id="3370716401-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="3370716401-4">)</span><span class="w">
|
|
</span><span class="n">trace!</span><span class="p" data-group-id="3370716401-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3370716401-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="3370716401-6">]</span><span class="p" data-group-id="3370716401-5">)</span><span class="w">
|
|
</span><span class="n">trace!</span><span class="p" data-group-id="3370716401-7">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3370716401-8">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="3370716401-8">}</span><span class="p" data-group-id="3370716401-7">)</span></code></pre>
|
|
</section>
|
|
</section>
|
|
|
|
</div>
|
|
</section>
|
|
|
|
<footer class="footer">
|
|
<p>
|
|
|
|
<span class="line">
|
|
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
|
|
Search HexDocs
|
|
</button>
|
|
|
|
<a href="bonfire_umbrella.epub" title="ePub version">
|
|
Download ePub version
|
|
</a>
|
|
|
|
</span>
|
|
</p>
|
|
|
|
<p class="built-using">
|
|
Built using
|
|
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.31.2) for the
|
|
|
|
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
|
|
|
|
</p>
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
|
|
|
|
</body>
|
|
</html>
|