Skip to content

Latest commit

 

History

History
75 lines (53 loc) · 1.75 KB

wizard.rst

File metadata and controls

75 lines (53 loc) · 1.75 KB

Wizard

Note

All wizard operations require either the ADMIN permission or the firstRun flag to be true.

Contents

Retrieve additional data about registered wizards

.. http:get:: /setup/wizard

   Retrieves additional data about the registered wizards.

   Returns a :http:statuscode:`200` with an object mapping wizard identifiers to :ref:`wizard data entries <sec-api-wizard-datamodel-wizarddata>`.

Finish wizards

.. http:post:: /setup/wizard

   Inform wizards that the wizard dialog has been finished.

   Expects a JSON request body containing a property ``handled`` which holds a list of wizard identifiers
   which were handled (not skipped) in the wizard dialog.

   Will call :func:`octoprint.plugin.WizardPlugin.on_wizard_finish` for all registered wizard plugins,
   supplying the information whether the wizard plugin's identifier was within the list of ``handled``
   wizards or not.

   :json handled: A list of handled wizards

Data model

Wizard data entry

Name Multiplicity Type Description
required 1 bool Whether the wizard needs to be run (true) or not (false)
details 1 object Details for the wizard's UI provided by the wizard plugin
version 1 int or null Version of the wizard
ignored 1 bool Whether the wizard has already been seen/is ignored (true) or not (false)