vikunjafile

Documentation

Index

• type FileMigrator
  • func (v *FileMigrator) Migrate(user *user.User, file io.ReaderAt, size int64) error
  • func (v *FileMigrator) Name() string

Types

type FileMigrator

type FileMigrator struct {
}

func (*FileMigrator) Migrate

func (v *FileMigrator) Migrate(user *user.User, file io.ReaderAt, size int64) error

Migrate takes a vikunja file export, parses it and imports everything in it into Vikunja. @Summary Import all lists, tasks etc. from a Vikunja data export @Description Imports all projects, tasks, notes, reminders, subtasks and files from a Vikunjda data export into Vikunja. @tags migration @Accept json @Produce json @Security JWTKeyAuth @Param import formData string true "The Vikunja export zip file." @Success 200 {object} models.Message "A message telling you everything was migrated successfully." @Failure 500 {object} models.Message "Internal server error" @Router /migration/vikunja-file/migrate [post]

func (*FileMigrator) Name

func (v *FileMigrator) Name() string

Name is used to get the name of the vikunja-file migration - we're using the docs here to annotate the status route. @Summary Get migration status @Description Returns if the current user already did the migation or not. This is useful to show a confirmation message in the frontend if the user is trying to do the same migration again. @tags migration @Produce json @Security JWTKeyAuth @Success 200 {object} migration.Status "The migration status" @Failure 500 {object} models.Message "Internal server error" @Router /migration/vikunja-file/status [get]