Skip to content

Commit

Permalink
Publish new build of docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 7, 2025
1 parent c2447a2 commit e17bd0c
Show file tree
Hide file tree
Showing 8 changed files with 0 additions and 243 deletions.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

12 changes: 0 additions & 12 deletions maintenance/api/push.html
Original file line number Diff line number Diff line change
Expand Up @@ -289,18 +289,6 @@
</div>
<p>An example for an auth roundtrip with only an API key using the <a class="reference internal" href="../jsclientlib/base.html#sec-jsclientlib-base"><span class="std std-ref">JS Client Library</span></a>
can be found <a class="reference internal" href="../jsclientlib/socket.html#sec-jsclient-socket-authsample"><span class="std std-ref">here</span></a>.</p>
<object data="../_images/mermaid-143e9094a93916e3434fbbcc18888b96ac90031e.svg" type="image/svg+xml">
<p class="warning">sequenceDiagram
participant Client
participant API
participant Websocket

Client-&gt;&gt;API: GET /api/login?passive=true&amp;apikey=...
API-&gt;&gt;Client: { name: ..., session: ..., ... }

note over Client: auth = name &quot;:&quot; session

Client-&gt;&gt;Websocket: { &quot;auth&quot;: auth }</p></object>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">throttle</span></code>: Usually, OctoPrint will push the general state update
in the <code class="docutils literal notranslate"><span class="pre">current</span></code> message twice per second. For some clients that might still
Expand Down
114 changes: 0 additions & 114 deletions maintenance/bundledplugins/appkeys.html
Original file line number Diff line number Diff line change
Expand Up @@ -234,62 +234,6 @@
an HTTP <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">404 Not Found</a>.</p></li>
</ol>
</div></blockquote>
<object data="../_images/mermaid-29cc0989a08e3995529dfe636546bddf4d51634b.svg" type="image/svg+xml">
<p class="warning">sequenceDiagram
participant User
participant App
participant Webinterface
participant Server

note over User, Server: Step 1, 2 &amp; 3

User-&gt;&gt;App: enters URL of instance to connect to and optional user_id

App-&gt;&gt;Server: GET /plugin/appkeys/probe

alt Workflow unsupported

Server-&gt;&gt;App: 404
App-&gt;&gt;User: alternative workflow, copy-paste key manually

else Workflow supported

App-&gt;&gt;Server: POST /plugin/appkeys/request, (app_name, user_id)

note over User, Server: Step 4

Server--&gt;&gt;Webinterface: plugin message for &quot;appkeys&quot; w/ (app_name, user_token, user_id)
Webinterface--&gt;&gt;User: Display confirmation dialog
Server-&gt;&gt;App: 201, Location: /plugin/appkeys/request/&lt;app_token&gt;

note over User, Server: Step 5

loop Poll for decision
App-&gt;&gt;Server: GET /plugin/appkeys/request/&lt;app_token&gt;
Server-&gt;&gt;App: 202
end

note over User, Server: Step 6 &amp; 7

alt User accepts

User--&gt;&gt;Webinterface: Allow access
Webinterface-&gt;&gt;Server: POST /plugin/appkeys/decision/&lt;user_token&gt;, (True)
Server-&gt;&gt;Webinterface: 204
App-&gt;&gt;Server: GET /plugin/appkeys/request/&lt;app_token&gt;
Server-&gt;&gt;App: 200, api_key

else User denies

User--&gt;&gt;Webinterface: Deny access
Webinterface-&gt;&gt;Server: POST /plugin/appkeys/decision/&lt;user_token&gt;, (False)
Server-&gt;&gt;Webinterface: 204
App-&gt;&gt;Server: GET /plugin/appkeys/request/&lt;app_token&gt;
Server-&gt;&gt;App: 404

end

end</p></object>
</section>
<section id="workflow-with-redirect-to-auth-dialog">
<span id="sec-bundledplugins-appkeys-workflow-authdialog"></span><h2>Workflow with redirect to auth dialog<a class="headerlink" href="#workflow-with-redirect-to-auth-dialog" title="Link to this heading"></a></h2>
Expand Down Expand Up @@ -322,64 +266,6 @@
an HTTP <a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">404 Not Found</a>.</p></li>
</ol>
</div></blockquote>
<object data="../_images/mermaid-1e2a4354753c75597109db1548404e3800e6202d.svg" type="image/svg+xml">
<p class="warning">sequenceDiagram
participant User
participant App
participant Auth Dialog
participant Server

note over User, Server: Step 1, 2 &amp; 3

User-&gt;&gt;App: enters URL of instance to connect to and optional user_id

App-&gt;&gt;Server: GET /plugin/appkeys/probe

alt Workflow unsupported

Server-&gt;&gt;App: 404
App-&gt;&gt;User: alternative workflow, copy-paste key manually

else Workflow supported

App-&gt;&gt;Server: POST /plugin/appkeys/request, (app_name, user_id)

note over User, Server: Step 4

Server-&gt;&gt;App: 201, Location: /plugin/appkeys/request/&lt;app_token&gt;, auth_dialog: &lt;auth_dialog&gt;

note over User, Server: Step 5

App--&gt;&gt;Auth Dialog: open new browser window with auth_dialog URL

loop Poll for decision
App-&gt;&gt;Server: GET /plugin/appkeys/request/&lt;app_token&gt;
Server-&gt;&gt;App: 202
end

note over User, Server: Step 6 &amp; 7

User-&gt;&gt;Auth Dialog: Logs in

alt User accepts

User--&gt;&gt;Auth Dialog: Allow access
Auth Dialog-&gt;&gt;Server: POST /plugin/appkeys/decision/&lt;user_token&gt;, (True)
Server-&gt;&gt;Auth Dialog: 204
App-&gt;&gt;Server: GET /plugin/appkeys/request/&lt;app_token&gt;
Server-&gt;&gt;App: 200, api_key

else User denies

User--&gt;&gt;Auth Dialog: Deny access
Auth Dialog-&gt;&gt;Server: POST /plugin/appkeys/decision/&lt;user_token&gt;, (False)
Server-&gt;&gt;Auth Dialog: 204
App-&gt;&gt;Server: GET /plugin/appkeys/request/&lt;app_token&gt;
Server-&gt;&gt;App: 404

end

end</p></object>
</section>
<section id="api">
<span id="sec-bundledplugins-appkeys-api"></span><h2>API<a class="headerlink" href="#api" title="Link to this heading"></a></h2>
Expand Down
112 changes: 0 additions & 112 deletions maintenance/plugins/viewmodels.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,121 +436,9 @@
<span id="sec-plugins-viewmodels-livecycle"></span><h2><a class="toc-backref" href="#id5" role="doc-backlink">Lifecycle diagrams</a><a class="headerlink" href="#lifecycle-diagrams" title="Link to this heading"></a></h2>
<section id="web-interface-startup">
<span id="sec-plugins-viewmodels-startup"></span><h3><a class="toc-backref" href="#id6" role="doc-backlink">Web interface startup</a><a class="headerlink" href="#web-interface-startup" title="Link to this heading"></a></h3>
<object data="../_images/mermaid-4fd41888a15fa9877db93b5414f72704048b4f41.svg" type="image/svg+xml">
<p class="warning">sequenceDiagram
participant Main
participant DataUpdater
participant LoginStateViewModel
participant SettingsViewModel
participant UiStateViewModel

Note over DataUpdater: connectCallback = undefined
Note over UiStateViewModel: loaded = false

activate Main

Main-&gt;&gt;+DataUpdater: connect
Note right of DataUpdater: initialized = false
DataUpdater--&gt;&gt;Main: ok
deactivate Main
DataUpdater-&gt;&gt;DataUpdater: asynchronous connect to server...
activate DataUpdater
Note right of DataUpdater: store any callbacks instead of triggering (e.g. onServerConnect, fromHistoryData, fromCurrentData, ...)
DataUpdater-X+Main: done
deactivate DataUpdater
deactivate DataUpdater

Main-&gt;&gt;+DataUpdater: connectCallback = onServerConnect
Note right of DataUpdater: connectCallback = onServerConnect
DataUpdater--&gt;&gt;-Main: ok
Main-&gt;&gt;+Main: onServerConnect
Main-&gt;&gt;+LoginStateViewModel: passiveLogin
LoginStateViewModel--&gt;&gt;Main: ok
Main--&gt;&gt;Main: ok
deactivate Main
deactivate Main

LoginStateViewModel-&gt;&gt;+LoginStateViewModel: asynchronous passive login
Note over Main,UiStateViewModel: Session available!
LoginStateViewModel-X+Main: done
deactivate LoginStateViewModel
deactivate LoginStateViewModel

Main-&gt;&gt;+DataUpdater: initialized
Note right of DataUpdater: initialized = true
DataUpdater-&gt;DataUpdater: trigger stored callbacks
DataUpdater--&gt;&gt;-Main: ok

Main-&gt;&gt;+Main: fetchSettings
Note right of Main: trigger onStartup

Main-&gt;&gt;+SettingsViewModel: requestData
SettingsViewModel--&gt;&gt;Main: ok
deactivate Main
deactivate Main

SettingsViewModel-&gt;&gt;+SettingsViewModel: asynchronous settings fetch
Note over Main,UiStateViewModel: Settings available!
SettingsViewModel-X+Main: done
deactivate SettingsViewModel
deactivate SettingsViewModel

Main-&gt;&gt;+Main: bindViewModels

loop for each view model
Main-&gt;Main: trigger onBeforeBinding
Main-&gt;Main: trigger onBoundTo
Main-&gt;Main: trigger onAfterBinding
end

Main-&gt;Main: trigger onAllBound
opt User is logged in
Main-&gt;&gt;+LoginStateViewModel: onAllBound
LoginStateViewModel-&gt;LoginStateViewModel: trigger onUserLoggedIn
LoginStateViewModel--&gt;&gt;-Main: ok
end

Main-&gt;&gt;+UiStateViewModel: loaded
Note right of UiStateViewModel: loaded = true
UiStateViewModel--&gt;&gt;-Main: ok

Main-&gt;Main: trigger onStartupComplete
deactivate Main
deactivate Main</p></object>
</section>
<section id="web-interface-reconnect">
<span id="sec-plugins-viewmodels-reconnect"></span><h3><a class="toc-backref" href="#id7" role="doc-backlink">Web interface reconnect</a><a class="headerlink" href="#web-interface-reconnect" title="Link to this heading"></a></h3>
<object data="../_images/mermaid-b6a68afb5de22645f94737e480e580e570c977a7.svg" type="image/svg+xml">
<p class="warning">sequenceDiagram
participant onServerConnect
participant DataUpdater
participant LoginStateViewModel

activate DataUpdater
DataUpdater-&gt;&gt;DataUpdater: call connectCallback
DataUpdater-&gt;&gt;+onServerConnect: call
onServerConnect--&gt;&gt;DataUpdater: ok
deactivate DataUpdater

onServerConnect-&gt;&gt;+LoginStateViewModel: passiveLogin
LoginStateViewModel--&gt;&gt;onServerConnect: ok
deactivate onServerConnect
LoginStateViewModel-&gt;&gt;+LoginStateViewModel: asynchronous passive login
Note over onServerConnect,LoginStateViewModel: Session available!
opt User is logged in
LoginStateViewModel-&gt;LoginStateViewModel: trigger onUserLoggedIn
end

activate onServerConnect
LoginStateViewModel-XonServerConnect: done
deactivate LoginStateViewModel
deactivate LoginStateViewModel

onServerConnect-&gt;&gt;+DataUpdater: initialized
DataUpdater-&gt;DataUpdater: trigger stored callbacks
DataUpdater--&gt;&gt;onServerConnect: ok
deactivate DataUpdater
deactivate onServerConnect</p></object>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
Expand Down

0 comments on commit e17bd0c

Please sign in to comment.