Skip to content

Commit 7800da5

Browse files
Publish new build of docs
1 parent 6444684 commit 7800da5

File tree

492 files changed

+1212
-1212
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

492 files changed

+1212
-1212
lines changed

1.10.3/api/access.html

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

1.10.3/api/connection.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@
201201
<dl class="field-list simple">
202202
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
203203
<dd class="field-odd"><ul class="simple">
204-
<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>
204+
<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>
205205
</ul>
206206
</dd>
207207
</dl>
@@ -305,8 +305,8 @@
305305
</dd>
306306
<dt class="field-even">Status Codes<span class="colon">:</span></dt>
307307
<dd class="field-even"><ul class="simple">
308-
<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>
309-
<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
308+
<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>
309+
<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
310310
options.</p></li>
311311
</ul>
312312
</dd>
@@ -350,7 +350,7 @@
350350
<div class="rst-other-versions">
351351
<dl>
352352
<dt>Tags</dt>
353-
<dd><a href="https://docs.octoprint.org/en/1.11.6/api/connection.html">1.11.6</a></dd>
353+
<dd><a href="https://docs.octoprint.org/en/1.11.7/api/connection.html">1.11.7</a></dd>
354354
<dd><a href="https://docs.octoprint.org/en/1.10.3/api/connection.html">1.10.3</a></dd>
355355
</dl>
356356
<dl>

1.10.3/api/datamodel.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1263,7 +1263,7 @@
12631263
<div class="rst-other-versions">
12641264
<dl>
12651265
<dt>Tags</dt>
1266-
<dd><a href="https://docs.octoprint.org/en/1.11.6/api/datamodel.html">1.11.6</a></dd>
1266+
<dd><a href="https://docs.octoprint.org/en/1.11.7/api/datamodel.html">1.11.7</a></dd>
12671267
<dd><a href="https://docs.octoprint.org/en/1.10.3/api/datamodel.html">1.10.3</a></dd>
12681268
</dl>
12691269
<dl>

1.10.3/api/files.html

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

1.10.3/api/general.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@
212212
<p>Please be advised that clients should use the header field variant if at all possible.</p>
213213
<p>If the key is missing or invalid, OctoPrint will treat the request as it would any unauthenticated anonymous request to the endpoint.
214214
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>
215-
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>
215+
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>
216216
<div class="admonition warning">
217217
<p class="admonition-title">Warning</p>
218218
<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
@@ -329,14 +329,14 @@
329329
<p>Can be used in one of two ways: to login a user via username and password and create a persistent session (usually
330330
from a UI in the browser), or to retrieve information about the active user (from an existing session or an API key)
331331
via the <code class="docutils literal notranslate"><span class="pre">passive</span></code> flag.</p>
332-
<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
333-
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
332+
<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
333+
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
334334
case of a username/password mismatch, unknown user or a deactivated account.</p>
335335
<div class="admonition warning">
336336
<p class="admonition-title">Warning</p>
337-
<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
337+
<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
338338
mismatch or an unknown user. That was incompatible with basic authentication since it was a wrong use of
339-
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>
339+
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>
340340
</div>
341341
<div class="admonition note">
342342
<p class="admonition-title">Note</p>
@@ -356,8 +356,8 @@
356356
</dd>
357357
<dt class="field-even">Status Codes<span class="colon">:</span></dt>
358358
<dd class="field-even"><ul class="simple">
359-
<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>
360-
<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>
359+
<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>
360+
<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>
361361
</ul>
362362
</dd>
363363
</dl>
@@ -371,11 +371,11 @@
371371
<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>
372372
<dd><p>Ends the current login session of the current user.</p>
373373
<p>Only makes sense in the context of browser based workflows.</p>
374-
<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>
374+
<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>
375375
<dl class="field-list simple">
376376
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
377377
<dd class="field-odd"><ul class="simple">
378-
<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>
378+
<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>
379379
</ul>
380380
</dd>
381381
</dl>
@@ -388,12 +388,12 @@
388388
<dt class="sig sig-object http" id="get--api-currentuser">
389389
<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>
390390
<dd><p>Retrieves information about the current user.</p>
391-
<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>
391+
<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>
392392
as body.</p>
393393
<dl class="field-list simple">
394394
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
395395
<dd class="field-odd"><ul class="simple">
396-
<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>
396+
<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>
397397
</ul>
398398
</dd>
399399
</dl>
@@ -505,7 +505,7 @@
505505
<div class="rst-other-versions">
506506
<dl>
507507
<dt>Tags</dt>
508-
<dd><a href="https://docs.octoprint.org/en/1.11.6/api/general.html">1.11.6</a></dd>
508+
<dd><a href="https://docs.octoprint.org/en/1.11.7/api/general.html">1.11.7</a></dd>
509509
<dd><a href="https://docs.octoprint.org/en/1.10.3/api/general.html">1.10.3</a></dd>
510510
</dl>
511511
<dl>

1.10.3/api/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@
318318
<div class="rst-other-versions">
319319
<dl>
320320
<dt>Tags</dt>
321-
<dd><a href="https://docs.octoprint.org/en/1.11.6/api/index.html">1.11.6</a></dd>
321+
<dd><a href="https://docs.octoprint.org/en/1.11.7/api/index.html">1.11.7</a></dd>
322322
<dd><a href="https://docs.octoprint.org/en/1.10.3/api/index.html">1.10.3</a></dd>
323323
</dl>
324324
<dl>

1.10.3/api/job.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -181,13 +181,13 @@
181181
<dd><p>Job commands allow starting, pausing and cancelling print jobs. Available commands are:</p>
182182
<dl>
183183
<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>.
184-
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>
184+
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>
185185
</dd>
186-
<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>
186+
<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>
187187
will be returned.</p>
188188
</dd>
189189
<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
190-
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>
190+
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>
191191
<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>
192192
</dd>
193193
<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>
@@ -202,7 +202,7 @@
202202
</dl>
203203
<p>In order to stay backwards compatible to earlier iterations of this API, the default
204204
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>
205-
<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>
205+
<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>
206206
<div class="admonition note">
207207
<p class="admonition-title">Note</p>
208208
<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>
@@ -212,7 +212,7 @@
212212
</div>
213213
</dd>
214214
</dl>
215-
<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>
215+
<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>
216216
<p>Requires the <code class="docutils literal notranslate"><span class="pre">PRINT</span></code> permission.</p>
217217
<p><strong>Example Start Request</strong></p>
218218
<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>
@@ -309,8 +309,8 @@
309309
</dd>
310310
<dt class="field-even">Status Codes<span class="colon">:</span></dt>
311311
<dd class="field-even"><ul class="simple">
312-
<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>
313-
<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
312+
<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>
313+
<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
314314
for the command.</p></li>
315315
</ul>
316316
</dd>
@@ -324,7 +324,7 @@
324324
<dt class="sig sig-object http" id="get--api-job">
325325
<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>
326326
<dd><p>Retrieve information about the current job (if there is one).</p>
327-
<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>
327+
<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>
328328
<p>Requires the <code class="docutils literal notranslate"><span class="pre">STATUS</span></code> permission.</p>
329329
<p><strong>Example</strong></p>
330330
<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>
@@ -364,7 +364,7 @@
364364
<dl class="field-list simple">
365365
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
366366
<dd class="field-odd"><ul class="simple">
367-
<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>
367+
<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>
368368
</ul>
369369
</dd>
370370
</dl>
@@ -452,7 +452,7 @@
452452
<div class="rst-other-versions">
453453
<dl>
454454
<dt>Tags</dt>
455-
<dd><a href="https://docs.octoprint.org/en/1.11.6/api/job.html">1.11.6</a></dd>
455+
<dd><a href="https://docs.octoprint.org/en/1.11.7/api/job.html">1.11.7</a></dd>
456456
<dd><a href="https://docs.octoprint.org/en/1.10.3/api/job.html">1.10.3</a></dd>
457457
</dl>
458458
<dl>

0 commit comments

Comments
 (0)