microsofttodo

Documentation

Index

• type Migration
  • func (m *Migration) AuthURL() string
  • func (m *Migration) Migrate(user *user.User) (err error)
  • func (m *Migration) Name() string

Types

type Migration

type Migration struct {
	Code string `json:"code"`
}

func (*Migration) AuthURL

func (m *Migration) AuthURL() string

AuthURL returns the url users need to authenticate against @Summary Get the auth url from Microsoft Todo @Description Returns the auth url where the user needs to get its auth code. This code can then be used to migrate everything from Microsoft Todo to Vikunja. @tags migration @Produce json @Security JWTKeyAuth @Success 200 {object} handler.AuthURL "The auth url." @Failure 500 {object} models.Message "Internal server error" @Router /migration/microsoft-todo/auth [get]

func (*Migration) Migrate

func (m *Migration) Migrate(user *user.User) (err error)

Migrate gets all tasks from Microsoft Todo for a user and puts them into vikunja @Summary Migrate all projects, tasks etc. from Microsoft Todo @Description Migrates all tasklinsts, tasks, notes and reminders from Microsoft Todo to Vikunja. @tags migration @Accept json @Produce json @Security JWTKeyAuth @Param migrationCode body microsofttodo.Migration true "The auth token previously obtained from the auth url. See the docs for /migration/microsoft-todo/auth." @Success 200 {object} models.Message "A message telling you everything was migrated successfully." @Failure 500 {object} models.Message "Internal server error" @Router /migration/microsoft-todo/migrate [post]

func (*Migration) Name

func (m *Migration) Name() string

Name is used to get the name of the Microsoft Todo 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/microsoft-todo/status [get]