Skip to content

Commit 6444684

Browse files
Publish new build of docs
1 parent b028c9c commit 6444684

File tree

18 files changed

+239
-239
lines changed

18 files changed

+239
-239
lines changed

main/api/access.html

Lines changed: 41 additions & 41 deletions
Large diffs are not rendered by default.

main/api/connection.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@
196196
<dl class="field-list simple">
197197
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
198198
<dd class="field-odd"><ul class="simple">
199-
<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>
199+
<li><p><span><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/200">200 OK</a></span> – No error</p></li>
200200
</ul>
201201
</dd>
202202
</dl>
@@ -300,8 +300,8 @@
300300
</dd>
301301
<dt class="field-even">Status Codes<span class="colon">:</span></dt>
302302
<dd class="field-even"><ul class="simple">
303-
<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>
304-
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a></span> – If the selected <cite>port</cite> or <cite>baudrate</cite> for a <code class="docutils literal notranslate"><span class="pre">connect</span></code> command are not part of the available
303+
<li><p><span><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/204">204 No Content</a></span> – No error</p></li>
304+
<li><p><span><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/400">400 Bad Request</a></span> – If the selected <cite>port</cite> or <cite>baudrate</cite> for a <code class="docutils literal notranslate"><span class="pre">connect</span></code> command are not part of the available
305305
options.</p></li>
306306
</ul>
307307
</dd>

main/api/files.html

Lines changed: 38 additions & 38 deletions
Large diffs are not rendered by default.

main/api/general.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<p>Please be advised that clients should use the header field variant if at all possible.</p>
208208
<p>If the key is missing or invalid, OctoPrint will treat the request as it would any unauthenticated anonymous request to the endpoint.
209209
That means that any requests without or with an invalid API key targeting other API endpoints than <a class="reference internal" href="#sec-api-general-login"><span class="std std-ref">Login</span></a>
210-
will be denied with a <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4">403 Forbidden</a>.</p>
210+
will be denied with a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/403">403 Forbidden</a>.</p>
211211
<div class="admonition warning">
212212
<p class="admonition-title">Warning</p>
213213
<p>If <a class="reference internal" href="../features/accesscontrol.html#sec-features-access-control"><span class="std std-ref">Access Control</span></a> is disabled, OctoPrint will treat any unauthenticated anonymous requests and thus also requests
@@ -324,14 +324,14 @@
324324
<p>Can be used in one of two ways: to login a user via username and password and create a persistent session (usually
325325
from a UI in the browser), or to retrieve information about the active user (from an existing session or an API key)
326326
via the <code class="docutils literal notranslate"><span class="pre">passive</span></code> flag.</p>
327-
<p>Will return a <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a> with a <a class="reference internal" href="#sec-api-general-datamodel-login"><span class="std std-ref">login response</span></a> on successful
328-
login, whether active or passive. The active (username/password) login may also return a <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4">403 Forbidden</a> in
327+
<p>Will return a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/200">200 OK</a> with a <a class="reference internal" href="#sec-api-general-datamodel-login"><span class="std std-ref">login response</span></a> on successful
328+
login, whether active or passive. The active (username/password) login may also return a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/403">403 Forbidden</a> in
329329
case of a username/password mismatch, unknown user or a deactivated account.</p>
330330
<div class="admonition warning">
331331
<p class="admonition-title">Warning</p>
332-
<p>Previous versions of this API endpoint did return a <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">401 Unauthorized</a> in case of a username/password
332+
<p>Previous versions of this API endpoint did return a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/401">401 Unauthorized</a> in case of a username/password
333333
mismatch or an unknown user. That was incompatible with basic authentication since it was a wrong use of
334-
the <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">401 Unauthorized</a> code and got therefore changed as part of a bug fix.</p>
334+
the <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/401">401 Unauthorized</a> code and got therefore changed as part of a bug fix.</p>
335335
</div>
336336
<div class="admonition note">
337337
<p class="admonition-title">Note</p>
@@ -351,8 +351,8 @@
351351
</dd>
352352
<dt class="field-even">Status Codes<span class="colon">:</span></dt>
353353
<dd class="field-even"><ul class="simple">
354-
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – Successful login</p></li>
355-
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4">403 Forbidden</a></span> – Username/password mismatch, unknown user or deactivated account</p></li>
354+
<li><p><span><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/200">200 OK</a></span> – Successful login</p></li>
355+
<li><p><span><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/403">403 Forbidden</a></span> – Username/password mismatch, unknown user or deactivated account</p></li>
356356
</ul>
357357
</dd>
358358
</dl>
@@ -366,11 +366,11 @@
366366
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/logout</span></span><a class="headerlink" href="#post--api-logout" title="Link to this definition"></a></dt>
367367
<dd><p>Ends the current login session of the current user.</p>
368368
<p>Only makes sense in the context of browser based workflows.</p>
369-
<p>Will return a <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.5">204 No Content</a>.</p>
369+
<p>Will return a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/204">204 No Content</a>.</p>
370370
<dl class="field-list simple">
371371
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
372372
<dd class="field-odd"><ul class="simple">
373-
<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>
373+
<li><p><span><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/204">204 No Content</a></span> – No error</p></li>
374374
</ul>
375375
</dd>
376376
</dl>
@@ -383,12 +383,12 @@
383383
<dt class="sig sig-object http" id="get--api-currentuser">
384384
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/currentuser</span></span><a class="headerlink" href="#get--api-currentuser" title="Link to this definition"></a></dt>
385385
<dd><p>Retrieves information about the current user.</p>
386-
<p>Will return a <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a> with a <a class="reference internal" href="#sec-api-general-datamodel-currentuser"><span class="std std-ref">current user object</span></a>
386+
<p>Will return a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/200">200 OK</a> with a <a class="reference internal" href="#sec-api-general-datamodel-currentuser"><span class="std std-ref">current user object</span></a>
387387
as body.</p>
388388
<dl class="field-list simple">
389389
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
390390
<dd class="field-odd"><ul class="simple">
391-
<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>
391+
<li><p><span><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/200">200 OK</a></span> – No error</p></li>
392392
</ul>
393393
</dd>
394394
</dl>

main/api/job.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -176,13 +176,13 @@
176176
<dd><p>Job commands allow starting, pausing and cancelling print jobs. Available commands are:</p>
177177
<dl>
178178
<dt>start</dt><dd><p>Starts the print of the currently selected file. For selecting a file, see <a class="reference internal" href="files.html#sec-api-fileops-filecommand"><span class="std std-ref">Issue a file command</span></a>.
179-
If a print job is already active, a <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10">409 Conflict</a> will be returned.</p>
179+
If a print job is already active, a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/409">409 Conflict</a> will be returned.</p>
180180
</dd>
181-
<dt>cancel</dt><dd><p>Cancels the current print job. If no print job is active (either paused or printing), a <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10">409 Conflict</a>
181+
<dt>cancel</dt><dd><p>Cancels the current print job. If no print job is active (either paused or printing), a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/409">409 Conflict</a>
182182
will be returned.</p>
183183
</dd>
184184
<dt>restart</dt><dd><p>Restart the print of the currently selected file from the beginning. There must be an active print job for this to work
185-
and the print job must currently be paused. If either is not the case, a <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10">409 Conflict</a> will be returned.</p>
185+
and the print job must currently be paused. If either is not the case, a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/409">409 Conflict</a> will be returned.</p>
186186
<p>Equivalent to issuing a <code class="docutils literal notranslate"><span class="pre">cancel</span></code> command while paused, directly followed by a <code class="docutils literal notranslate"><span class="pre">start</span></code> command.</p>
187187
</dd>
188188
<dt>pause</dt><dd><p>Pauses/resumes/toggles the current print job. Accepts one optional additional parameter <code class="docutils literal notranslate"><span class="pre">action</span></code>
@@ -197,7 +197,7 @@
197197
</dl>
198198
<p>In order to stay backwards compatible to earlier iterations of this API, the default
199199
action to take if no <code class="docutils literal notranslate"><span class="pre">action</span></code> parameter is supplied is to toggle the print job status.</p>
200-
<p>If no print job is active (either paused or printing), a <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10">409 Conflict</a> will be returned.</p>
200+
<p>If no print job is active (either paused or printing), a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/409">409 Conflict</a> will be returned.</p>
201201
<div class="admonition note">
202202
<p class="admonition-title">Note</p>
203203
<p>While the approach to implement pause/resume/toggle behaviour through sub commands via the <code class="docutils literal notranslate"><span class="pre">action</span></code>
@@ -207,7 +207,7 @@
207207
</div>
208208
</dd>
209209
</dl>
210-
<p>Upon success, a status code of <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 is returned.</p>
210+
<p>Upon success, a status code of <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/204">204 No Content</a> and an empty body is returned.</p>
211211
<p>Requires the <code class="docutils literal notranslate"><span class="pre">PRINT</span></code> permission.</p>
212212
<p><strong>Example Start Request</strong></p>
213213
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/job</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
@@ -304,8 +304,8 @@
304304
</dd>
305305
<dt class="field-even">Status Codes<span class="colon">:</span></dt>
306306
<dd class="field-even"><ul class="simple">
307-
<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>
308-
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10">409 Conflict</a></span> – If the printer is not operational or the current print job state does not match the preconditions
307+
<li><p><span><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/204">204 No Content</a></span> – No error</p></li>
308+
<li><p><span><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/409">409 Conflict</a></span> – If the printer is not operational or the current print job state does not match the preconditions
309309
for the command.</p></li>
310310
</ul>
311311
</dd>
@@ -319,7 +319,7 @@
319319
<dt class="sig sig-object http" id="get--api-job">
320320
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/job</span></span><a class="headerlink" href="#get--api-job" title="Link to this definition"></a></dt>
321321
<dd><p>Retrieve information about the current job (if there is one).</p>
322-
<p>Returns a <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a> with a <a class="reference internal" href="#sec-api-job-datamodel-response"><span class="std std-ref">Job information response</span></a> in the body.</p>
322+
<p>Returns a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/200">200 OK</a> with a <a class="reference internal" href="#sec-api-job-datamodel-response"><span class="std std-ref">Job information response</span></a> in the body.</p>
323323
<p>Requires the <code class="docutils literal notranslate"><span class="pre">STATUS</span></code> permission.</p>
324324
<p><strong>Example</strong></p>
325325
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/job</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
@@ -359,7 +359,7 @@
359359
<dl class="field-list simple">
360360
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
361361
<dd class="field-odd"><ul class="simple">
362-
<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>
362+
<li><p><span><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/200">200 OK</a></span> – No error</p></li>
363363
</ul>
364364
</dd>
365365
</dl>

main/api/languages.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@
225225
<dl class="field-list simple">
226226
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
227227
<dd class="field-odd"><ul class="simple">
228-
<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>
228+
<li><p><span><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/200">200 OK</a></span> – No error</p></li>
229229
</ul>
230230
</dd>
231231
</dl>
@@ -243,7 +243,7 @@
243243
<p>To upload a file, the request body must contain the <code class="docutils literal notranslate"><span class="pre">file</span></code> form field with the
244244
contents and file name of the file to upload.</p>
245245
<p>Only files with one of the extensions <code class="docutils literal notranslate"><span class="pre">zip</span></code>, <code class="docutils literal notranslate"><span class="pre">tar.gz</span></code>, <code class="docutils literal notranslate"><span class="pre">tgz</span></code> or <code class="docutils literal notranslate"><span class="pre">tar</span></code> will be
246-
processed, for other file extensions a <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a> will be returned.</p>
246+
processed, for other file extensions a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/400">400 Bad Request</a> will be returned.</p>
247247
<p>Will return a list of installed language packs upon completion, as described in
248248
<a class="reference internal" href="#sec-api-languages-list"><span class="std std-ref">Retrieve installed language packs</span></a>.</p>
249249
<dl class="field-list simple">
@@ -254,7 +254,7 @@
254254
</dd>
255255
<dt class="field-even">Status Codes<span class="colon">:</span></dt>
256256
<dd class="field-even"><ul class="simple">
257-
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – The file was uploaded successfully</p></li>
257+
<li><p><span><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/200">200 OK</a></span> – The file was uploaded successfully</p></li>
258258
</ul>
259259
</dd>
260260
</dl>
@@ -312,7 +312,7 @@
312312
</dd>
313313
<dt class="field-even">Status Codes<span class="colon">:</span></dt>
314314
<dd class="field-even"><ul class="simple">
315-
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – The language pack was deleted</p></li>
315+
<li><p><span><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/200">200 OK</a></span> – The language pack was deleted</p></li>
316316
</ul>
317317
</dd>
318318
</dl>

0 commit comments

Comments
 (0)