Skip to content

Commit 79145ea

Browse files
Publish new build of docs
1 parent a638fec commit 79145ea

File tree

2 files changed

+88
-0
lines changed

2 files changed

+88
-0
lines changed

dev/_sources/api/printerprofiles.rst.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,9 @@ Update an existing printer profile
332332

333333
Requires the ``SETTINGS`` permission.
334334

335+
:statuscode 200: No error
336+
:statuscode 404: The profile does not exist
337+
335338
**Example**
336339

337340
.. sourcecode:: http
@@ -418,6 +421,10 @@ Remove an existing printer profile
418421

419422
Requires the ``SETTINGS`` permission.
420423

424+
:statuscode 204: No error
425+
:statuscode 404: The profile does not exist
426+
:statuscode 409: The profile is the currently selected or default profile
427+
421428
**Example**
422429

423430
.. sourcecode:: http

dev/api/printerprofiles.html

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -822,6 +822,22 @@
822822
</span>
823823
</a>
824824

825+
<nav class="md-nav" aria-label="PATCH /api/printerprofiles/">
826+
<ul class="md-nav__list">
827+
828+
<li class="md-nav__item">
829+
<a href="#patch--api-printerprofiles-(string-profile)-status-codes" class="md-nav__link">
830+
831+
<span class="md-ellipsis">
832+
<span>Status Codes</span>
833+
</span>
834+
</a>
835+
836+
</li>
837+
838+
</ul>
839+
</nav>
840+
825841
</li>
826842

827843
</ul>
@@ -848,6 +864,22 @@
848864
</span>
849865
</a>
850866

867+
<nav class="md-nav" aria-label="DELETE /api/printerprofiles/">
868+
<ul class="md-nav__list">
869+
870+
<li class="md-nav__item">
871+
<a href="#delete--api-printerprofiles-(string-profile)-status-codes" class="md-nav__link">
872+
873+
<span class="md-ellipsis">
874+
<span>Status Codes</span>
875+
</span>
876+
</a>
877+
878+
</li>
879+
880+
</ul>
881+
</nav>
882+
851883
</li>
852884

853885
</ul>
@@ -1385,6 +1417,22 @@
13851417
</span>
13861418
</a>
13871419

1420+
<nav class="md-nav" aria-label="PATCH /api/printerprofiles/">
1421+
<ul class="md-nav__list">
1422+
1423+
<li class="md-nav__item">
1424+
<a href="#patch--api-printerprofiles-(string-profile)-status-codes" class="md-nav__link">
1425+
1426+
<span class="md-ellipsis">
1427+
<span>Status Codes</span>
1428+
</span>
1429+
</a>
1430+
1431+
</li>
1432+
1433+
</ul>
1434+
</nav>
1435+
13881436
</li>
13891437

13901438
</ul>
@@ -1411,6 +1459,22 @@
14111459
</span>
14121460
</a>
14131461

1462+
<nav class="md-nav" aria-label="DELETE /api/printerprofiles/">
1463+
<ul class="md-nav__list">
1464+
1465+
<li class="md-nav__item">
1466+
<a href="#delete--api-printerprofiles-(string-profile)-status-codes" class="md-nav__link">
1467+
1468+
<span class="md-ellipsis">
1469+
<span>Status Codes</span>
1470+
</span>
1471+
</a>
1472+
1473+
</li>
1474+
1475+
</ul>
1476+
</nav>
1477+
14141478
</li>
14151479

14161480
</ul>
@@ -1780,6 +1844,14 @@ <h2 id="update-an-existing-printer-profile"><span id="sec-api-printerprofiles-up
17801844
<p>Returns a <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a> with the saved profile as property <code class="docutils literal notranslate"><span class="pre">profile</span></code>
17811845
in the JSON body upon success.</p>
17821846
<p>Requires the <code class="docutils literal notranslate"><span class="pre">SETTINGS</span></code> permission.</p>
1847+
<dl class="field-list simple">
1848+
<dt class="field-odd" id="patch--api-printerprofiles-(string-profile)-status-codes">Status Codes<span class="colon">:</span><a class="headerlink" href="#patch--api-printerprofiles-(string-profile)-status-codes" title="Permalink to this headline"></a></dt>
1849+
<dd class="field-odd"><ul class="simple">
1850+
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – No error</p></li>
1851+
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">404 Not Found</a></span> – The profile does not exist</p></li>
1852+
</ul>
1853+
</dd>
1854+
</dl>
17831855
<p><strong>Example</strong></p>
17841856
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><code><span class="nf">PATCH</span> <span class="nn">/api/printerprofiles/some_profile</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
17851857
<span class="na">Host</span><span class="o">:</span> <span class="l">example.com</span>
@@ -1857,6 +1929,15 @@ <h2 id="remove-an-existing-printer-profile"><span id="sec-api-printerprofiles-de
18571929
returned.</p>
18581930
<p>Returns a <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.5">204 No Content</a> and an empty body upon success.</p>
18591931
<p>Requires the <code class="docutils literal notranslate"><span class="pre">SETTINGS</span></code> permission.</p>
1932+
<dl class="field-list simple">
1933+
<dt class="field-odd" id="delete--api-printerprofiles-(string-profile)-status-codes">Status Codes<span class="colon">:</span><a class="headerlink" href="#delete--api-printerprofiles-(string-profile)-status-codes" title="Permalink to this headline"></a></dt>
1934+
<dd class="field-odd"><ul class="simple">
1935+
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.5">204 No Content</a></span> – No error</p></li>
1936+
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">404 Not Found</a></span> – The profile does not exist</p></li>
1937+
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10">409 Conflict</a></span> – The profile is the currently selected or default profile</p></li>
1938+
</ul>
1939+
</dd>
1940+
</dl>
18601941
<p><strong>Example</strong></p>
18611942
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><code><span class="nf">DELETE</span> <span class="nn">/api/printerprofiles/some_profile</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
18621943
<span class="na">Host</span><span class="o">:</span> <span class="l">example.com</span>

0 commit comments

Comments
 (0)