Skip to content

Commit 763cc94

Browse files
github-actions[bot]github-actions[bot]
committed
Publish new build of docs
1 parent 16c61b5 commit 763cc94

22 files changed

+355
-225
lines changed

‎dev/_sources/api/connection.rst.txt‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Get connection settings
1111

1212
.. md-tab-set::
1313

14-
.. md-tab-item:: API version 1.12.0+
14+
.. md-tab-item:: API version 2.0.0+
1515

1616
.. http:get:: /api/connection
1717
@@ -27,7 +27,7 @@ Get connection settings
2727
GET /api/connection HTTP/1.1
2828
Host: example.com
2929
Authorization: Bearer abcdef...
30-
X-OctoPrint-Api-Version: 1.12.0
30+
X-OctoPrint-Api-Version: 2.0.0
3131

3232
.. sourcecode:: http
3333

@@ -94,7 +94,7 @@ Get connection settings
9494

9595
:statuscode 200: No error
9696

97-
.. md-tab-item:: API version pre 1.12.0
97+
.. md-tab-item:: API version pre 2.0.0
9898

9999
.. http:get:: /api/connection
100100
@@ -106,8 +106,8 @@ Get connection settings
106106
.. note::
107107

108108
This version of the API doesn't yet support other connectors than the serial connector. If you want to
109-
support OctoPrint's printer connector model as available from 1.12.0 onward, you need to :ref:`version <sec-api-general-versioning>`
110-
your API requests accordingly to access the 1.12.0+ version of this API!
109+
support OctoPrint's printer connector model as available from 2.0.0 onward, you need to :ref:`version <sec-api-general-versioning>`
110+
your API requests accordingly to access the 2.0.0+ version of this API!
111111

112112
**Example**
113113

@@ -149,7 +149,7 @@ Issue a connection command
149149

150150
.. md-tab-set::
151151

152-
.. md-tab-item:: API version 1.12.0+
152+
.. md-tab-item:: API version 2.0.0+
153153

154154
.. http:post:: /api/connection
155155
@@ -189,7 +189,7 @@ Issue a connection command
189189
Host: example.com
190190
Content-Type: application/json
191191
Authorization: Bearer abcdef...
192-
X-OctoPrint-Api-Version: 1.12.0
192+
X-OctoPrint-Api-Version: 2.0.0
193193

194194
{
195195
"command": "connect",
@@ -215,7 +215,7 @@ Issue a connection command
215215
Host: example.com
216216
Content-Type: application/json
217217
Authorization: Bearer abcdef...
218-
X-OctoPrint-Api-Version: 1.12.0
218+
X-OctoPrint-Api-Version: 2.0.0
219219

220220
{
221221
"command": "disconnect"
@@ -233,7 +233,7 @@ Issue a connection command
233233
Host: example.com
234234
Content-Type: application/json
235235
Authorization: Bearer abcdef...
236-
X-OctoPrint-Api-Version: 1.12.0
236+
X-OctoPrint-Api-Version: 2.0.0
237237

238238
{
239239
"command": "repair"
@@ -257,7 +257,7 @@ Issue a connection command
257257
options.
258258
:statuscode 412: It was not possible to connect to the printer due to unmet preconditions (e.g. port unavailable, host unavailable, ...)
259259

260-
.. md-tab-item:: API version pre 1.12.0
260+
.. md-tab-item:: API version pre 2.0.0
261261

262262
.. http:post:: /api/connection
263263

‎dev/_sources/api/files.rst.txt‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
File operations
55
***************
66

7-
.. versionchanged:: 1.12.0
7+
.. versionchanged:: 2.0.0
88

99
API versioning, ``sdcard`` renamed to ``printer``
1010

@@ -15,7 +15,7 @@ Retrieve all files
1515

1616
.. md-tab-set::
1717

18-
.. md-tab-item:: API version 1.12.0+
18+
.. md-tab-item:: API version 2.0.0+
1919

2020
.. http:get:: /api/files
2121
@@ -41,7 +41,7 @@ Retrieve all files
4141
GET /api/files HTTP/1.1
4242
Host: example.com
4343
Authorization: Bearer abcdef...
44-
X-OctoPrint-Api-Version: 1.12.0
44+
X-OctoPrint-Api-Version: 2.0.0
4545

4646
.. sourcecode:: http
4747

@@ -154,7 +154,7 @@ Retrieve all files
154154
GET /api/files?recursive=true HTTP/1.1
155155
Host: example.com
156156
Authorization: Bearer abcdef...
157-
X-OctoPrint-Api-Version: 1.12.0
157+
X-OctoPrint-Api-Version: 2.0.0
158158

159159
.. sourcecode:: http
160160

@@ -293,7 +293,7 @@ Retrieve all files
293293
:param recursive: If set to ``true``, return all files and folders recursively. Otherwise only return items on same level.
294294
:statuscode 200: No error
295295

296-
.. md-tab-item:: API version pre 1.12.0
296+
.. md-tab-item:: API version pre 2.0.0
297297

298298
.. http:get:: /api/files
299299
@@ -500,7 +500,7 @@ Retrieve data of specific storage
500500

501501
.. md-tab-set::
502502

503-
.. md-tab-item:: API version 1.12.0+
503+
.. md-tab-item:: API version 2.0.0+
504504

505505
.. http:get:: /api/files/(string:storage)
506506
@@ -521,7 +521,7 @@ Retrieve data of specific storage
521521
GET /api/files/local HTTP/1.1
522522
Host: example.com
523523
Authorization: Bearer abcdef...
524-
X-OctoPrint-Api-Version: 1.12.0
524+
X-OctoPrint-Api-Version: 2.0.0
525525

526526
.. sourcecode:: http
527527

@@ -597,7 +597,7 @@ Retrieve data of specific storage
597597
:statuscode 200: No error
598598
:statuscode 404: If `storage` is not one of the registered storages (stock: ``local``, ``printer``)
599599

600-
.. md-tab-item:: API version pre 1.12.0
600+
.. md-tab-item:: API version pre 2.0.0
601601

602602
.. http:get:: /api/files/(string:storage)
603603
@@ -676,7 +676,7 @@ Upload file or create folder
676676

677677
.. md-tab-set::
678678

679-
.. md-tab-item:: API version 1.12.0+
679+
.. md-tab-item:: API version 2.0.0+
680680

681681
.. http:post:: /api/files/(string:storage)
682682
@@ -854,7 +854,7 @@ Upload file or create folder
854854
is disabled)
855855
:statuscode 500: If the upload failed internally
856856

857-
.. md-tab-item:: API version pre 1.12.0
857+
.. md-tab-item:: API version pre 2.0.0
858858

859859
.. http:post:: /api/files/(string:storage)
860860
@@ -1161,7 +1161,7 @@ Issue a file command
11611161

11621162
Requires the ``FILES_UPLOAD`` permission.
11631163

1164-
.. versionchanged:: 1.12.0
1164+
.. versionchanged:: 2.0.0
11651165

11661166
cross-storage support
11671167

@@ -1198,7 +1198,7 @@ Issue a file command
11981198

11991199
Requires the ``FILES_UPLOAD`` permission.
12001200

1201-
.. versionchanged:: 1.12.0
1201+
.. versionchanged:: 2.0.0
12021202

12031203
cross-storage support
12041204

@@ -1215,7 +1215,7 @@ Issue a file command
12151215

12161216
Requires the ``FILES_UPLOAD`` permission.
12171217

1218-
.. versionadded:: 1.12.0
1218+
.. versionadded:: 2.0.0
12191219

12201220
slice
12211221
Slices an STL file into GCODE. Note that this is an asynchronous operation that will take place in the background
@@ -1455,20 +1455,20 @@ Data model
14551455

14561456
.. _sec-api-fileops-datamodel-readfiles-pre-1_12:
14571457

1458-
Files response (pre 1.12.0)
1458+
Files response (pre 2.0.0)
14591459
---------------------------
14601460

1461-
.. pydantic-table:: octoprint.schema.api.files.ReadGcodeFilesResponse_pre_1_12
1461+
.. pydantic-table:: octoprint.schema.api.files.ReadGcodeFilesResponse_pre_2_0_0
14621462

14631463
octoprint.schema.api.files.ApiStorageFile = File
14641464
octoprint.schema.api.files.ApiStorageFolder = Folder
14651465

14661466
.. _sec-api-fileops-datamodel-readstorage-pre-1_12:
14671467

1468-
Files for storage response (pre 1.12.0)
1468+
Files for storage response (pre 2.0.0)
14691469
---------------------------------------
14701470

1471-
.. pydantic-table:: octoprint.schema.api.files.ReadGcodeFilesForOriginResponse_pre_1_12
1471+
.. pydantic-table:: octoprint.schema.api.files.ReadGcodeFilesForOriginResponse_pre_2_0_0
14721472

14731473
octoprint.schema.api.files.ApiStorageFile = File
14741474
octoprint.schema.api.files.ApiStorageFolder = Folder
@@ -1485,10 +1485,10 @@ Upload response
14851485

14861486
.. _sec-api-fileops-datamodel-uploadresponse-pre-1_12:
14871487

1488-
Upload response (pre 1.12.0)
1488+
Upload response (pre 2.0.0)
14891489
----------------------------
14901490

1491-
.. pydantic-table:: octoprint.schema.api.files.UploadResponse_pre_1_12
1491+
.. pydantic-table:: octoprint.schema.api.files.UploadResponse_pre_2_0_0
14921492

14931493
octoprint.schema.api.files.ApiAddedEntry = AddedEntry
14941494
ApiAddedEntry = AddedEntry

‎dev/_sources/api/general.rst.txt‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ authorization workflow implemented by the bundled :ref:`Application Keys Plugin
1515

1616
Clients are advised to implement the :ref:`Application Keys Plugin workflow <sec-bundledplugins-appkeys-workflow>` first and
1717
fallback on directing the user to manually supply the user specific API key. The global key is deprecated, will be removed
18-
in 1.13.0 and should no longer be used.
18+
in 2.1.0 and should no longer be used.
1919

2020
The API key must either be supplied in the custom HTTP header ``X-Api-Key``, e.g.
2121

@@ -58,19 +58,19 @@ will be denied with a :http:statuscode:`403`.
5858
:align: center
5959
:alt: Global API key in the API settings
6060

61-
The global API key can be found in the "API" settings. However, it is deprecated and will be removed in 1.13.0.
61+
The global API key can be found in the "API" settings. However, it is deprecated and will be removed in 2.1.0.
6262

6363
.. _sec-api-general-versioning:
6464

6565
API Versioning
6666
==============
6767

68-
.. versionadded:: 1.12.0
68+
.. versionadded:: 2.0.0
6969

7070
OctoPrint supports requesting a certain API version on requests by setting the ``X-OctoPrint-Api-Version`` header
7171
accordingly. API versions hereby the implementation as present in OctoPrint's server versions.
7272

73-
If the header is left out, the API will behave according to its documented pre-1.12.0 behaviour. If the header is set, the API will
73+
If the header is left out, the API will behave according to its documented pre-2.0.0 behaviour. If the header is set, the API will
7474
follow the behaviour found in that OctoPrint version.
7575

7676
Example without explicit version:
@@ -88,27 +88,27 @@ Example without explicit version:
8888

8989
{
9090
"api": "0.1",
91-
"server": "1.12.0",
92-
"text": "OctoPrint 1.12.0"
91+
"server": "2.0.0",
92+
"text": "OctoPrint 2.0.0"
9393
}
9494

95-
Example with a requested API version of 1.12.0:
95+
Example with a requested API version of 2.0.0:
9696

9797
.. sourcecode:: http
9898

9999
GET /api/version HTTP/1.1
100100
Host: example.com
101101
Authorization: Bearer abcdef...
102-
X-OctoPrint-Api-Version: 1.12.0
102+
X-OctoPrint-Api-Version: 2.0.0
103103

104104
.. sourcecode:: http
105105

106106
HTTP/1.1 200 OK
107107
Content-Type: application/json
108108

109109
{
110-
"server": "1.12.0",
111-
"text": "OctoPrint 1.12.0"
110+
"server": "2.0.0",
111+
"text": "OctoPrint 2.0.0"
112112
}
113113

114114
Clients should move to defining the specific versions they support from now on, to make it possible to implement new functionality in

‎dev/_sources/api/job.rst.txt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Job operations
55
**************
66

7-
.. versionchanged:: 1.12.0
7+
.. versionchanged:: 2.0.0
88

99
API versioning
1010

@@ -178,7 +178,7 @@ Retrieve information about the current job
178178

179179
.. md-tab-set::
180180

181-
.. md-tab-item:: API version 1.12.0+
181+
.. md-tab-item:: API version 2.0.0+
182182

183183
.. http:get:: /api/job
184184
@@ -230,7 +230,7 @@ Retrieve information about the current job
230230

231231
:statuscode 200: No error
232232

233-
.. md-tab-item:: API version pre 1.12.0
233+
.. md-tab-item:: API version pre 2.0.0
234234

235235
.. http:get:: /api/job
236236
@@ -297,7 +297,7 @@ Job information response
297297

298298
.. _sec-api-job-datamodel-response-pre-1_12:
299299

300-
Job information response (pre 1.12.0)
300+
Job information response (pre 2.0.0)
301301
-------------------------------------
302302

303-
.. pydantic-table:: octoprint.schema.api.job.ApiJobResponse_pre_1_12
303+
.. pydantic-table:: octoprint.schema.api.job.ApiJobResponse_pre_2_0_0

0 commit comments

Comments
 (0)