octoprint-open-api/TODO.md

TODO

General

• handle authorization header
• update readme

Routes

• Login

• Logout

• Current User

• Version

• Connection Handling

• File Operations link

  • Retrieve all files
  • Retrieve files from specific location
  • Upload file or create folder
  • Retrieve a specific file’s or folder’s information
  • Issue a file command
  • Delete file
  • Model: Upload response
  • Model: Retrieve response

• Job operations link

  • Issue a job command
  • Retrieve information about the current job
  • Model: Job information response

• Languages link

  • Retrieve installed language packs
  • Upload a language pack
  • Delete a language pack
  • Model: List response
  • Model: Component list
  • Model: Language pack metadata

• Log file management (Plugin?) link

  • Retrieve a list of available log files
  • Delete a specific logfile
  • Model: Logfile Retrieve Response
  • Model: File information
  • Model: References

• Printer operations link

  • Retrieve the current printer state
  • Issue a print head command
  • Issue a tool command
  • Retrieve the current tool state
  • Issue a bed command
  • Retrieve the current bed state
  • Issue a chamber command
  • Retrieve the current chamber state
  • Issue an SD command
  • Retrieve the current SD state
  • Send an arbitrary command to the printer
  • Retrieve custom controls (PARTIAL)
  • Model: Full State Response
  • Model: Temperature State
  • Model: SD State
  • Model: Arbitrary Command Request

• Printer profile operations link

  • Retrieve all printer profiles
  • Retrieve a single printer profile
  • Add a new printer profile
  • Update an existing printer profile
  • Remove an existing printer profile
  • Model: Profile list
  • Model: Add or update request
  • Model: Profile

• Settings link

  • Retrieve current settings
  • Save settings
  • Regenerate the system wide API key
  • Fetch template data
  • Model: Config

• Slicing TBD link

• System link

  • List all registered system commands
  • List all registered system commands for a source
  • Execute a registed system command
  • Model: List all response
  • Model: Client command definitions
  • Model: Command definition

• Timelapse link

  • Retrieve a list of timelapses and the current config
  • Delete a timelapse
  • Issue a command for an unrendered timelapse
  • Delete an unrendered timelapse
  • Change current timelapse config
  • Model: Timelapse list
  • Model: Rendered timelapse
  • Model: Unrendered timelapse
  • Model: Timelapse configuration
  • Model: Z-change-triggered timelapse
  • Model: Time triggered timelapse

• Access Control link

  • List all permissions

  Groups

  • Get group list
  • Add a new group
  • Retrieve a group
  • Update a group
  • Delete a group

  Users

  • Retrieve list of users
  • Retrieve user
  • Add new user
  • Update user
  • Delete user
  • Change users password
  • Get a users password
  • Update users password
  • Update users settings
  • Regenerate users api key
  • Delete users api key
  • Model: Permission list response
  • Model: Group list response
  • Model: Group registration request
  • Model: Group update request
  • Model: User list response
  • Model: User registration request
  • Model: User update request

• Util link

  • Test paths or URLs
  • Model: Path test result
  • Model: URL test result
  • Server test result
  • Resolution test result

• Wizard link

  • Retrieve additional data about registered wizards
  • Finish wizards
  • Model: Wizard data entry

• Common Data models link

LATER

• Model: Custom Controls Response
• Retrieve custom controls (FULL)