types

Documentation

Index

• type DiffEntry
• type DiffMeta
• type DocUpdateBounds
• type DocUpdateMeta
• type GetDocDiffRequest
  • func (r *GetDocDiffRequest) FromQuery(q url.Values) error
  • func (r *GetDocDiffRequest) FromSignedProjectOptions(o sharedTypes.ProjectOptions)
  • func (r *GetDocDiffRequest) Validate() error
• type GetDocDiffResponse
• type GetProjectHistoryUpdatesRequest
  • func (r *GetProjectHistoryUpdatesRequest) FromQuery(q url.Values) error
  • func (r *GetProjectHistoryUpdatesRequest) FromSignedProjectOptions(o sharedTypes.ProjectOptions)
• type GetProjectHistoryUpdatesResponse
• type RestoreDocVersionRequest
  • func (r *RestoreDocVersionRequest) FromSignedProjectOptions(o sharedTypes.ProjectOptions)
• type Update

Types

type DiffEntry

type DiffEntry struct {
	Meta DiffMeta `json:"meta,omitempty"`

	Deletion  sharedTypes.Snippet `json:"d,omitempty"`
	Insertion sharedTypes.Snippet `json:"i,omitempty"`
	Unchanged sharedTypes.Snippet `json:"u,omitempty"`
}

type DiffMeta

type DiffMeta struct {
	User user.WithPublicInfoAndNonStandardId `json:"user,omitempty"`

	StartTS sharedTypes.Timestamp `json:"start_ts"`
	EndTS   sharedTypes.Timestamp `json:"end_ts"`
}

type DocUpdateBounds

type DocUpdateBounds struct {
	FromV sharedTypes.Version `json:"fromV"`
	ToV   sharedTypes.Version `json:"toV"`
}

type DocUpdateMeta

type DocUpdateMeta struct {
	UserIds []sharedTypes.UUID                    `json:"user_ids,omitempty"`
	Users   []user.WithPublicInfoAndNonStandardId `json:"users,omitempty"`
	StartTS sharedTypes.Timestamp                 `json:"start_ts"`
	EndTS   sharedTypes.Timestamp                 `json:"end_ts"`
}

type GetDocDiffRequest

type GetDocDiffRequest struct {
	ProjectId sharedTypes.UUID `json:"-"`
	DocId     sharedTypes.UUID `json:"-"`
	UserId    sharedTypes.UUID `json:"-"`

	From sharedTypes.Version `form:"from" json:"from"`
	To   sharedTypes.Version `form:"to" json:"to"`
}

func (*GetDocDiffRequest) FromQuery

func (r *GetDocDiffRequest) FromQuery(q url.Values) error

func (*GetDocDiffRequest) FromSignedProjectOptions

func (r *GetDocDiffRequest) FromSignedProjectOptions(o sharedTypes.ProjectOptions)

func (*GetDocDiffRequest) Validate

func (r *GetDocDiffRequest) Validate() error

type GetDocDiffResponse

type GetDocDiffResponse struct {
	Diff []DiffEntry `json:"diff"`
}

type GetProjectHistoryUpdatesRequest

type GetProjectHistoryUpdatesRequest struct {
	ProjectId sharedTypes.UUID `json:"-"`
	UserId    sharedTypes.UUID `json:"-"`

	Before sharedTypes.Timestamp `form:"before" json:"before"`
}

func (*GetProjectHistoryUpdatesRequest) FromQuery

func (r *GetProjectHistoryUpdatesRequest) FromQuery(q url.Values) error

func (*GetProjectHistoryUpdatesRequest) FromSignedProjectOptions

func (r *GetProjectHistoryUpdatesRequest) FromSignedProjectOptions(o sharedTypes.ProjectOptions)

type GetProjectHistoryUpdatesResponse

type GetProjectHistoryUpdatesResponse struct {
	Updates             []Update              `json:"updates"`
	NextBeforeTimestamp sharedTypes.Timestamp `json:"nextBeforeTimestamp,omitempty"`
}

type RestoreDocVersionRequest

type RestoreDocVersionRequest struct {
	ProjectId sharedTypes.UUID `json:"-"`
	DocId     sharedTypes.UUID `json:"-"`
	UserId    sharedTypes.UUID `json:"-"`

	FromV sharedTypes.Version `json:"from_v"`
}

func (*RestoreDocVersionRequest) FromSignedProjectOptions

func (r *RestoreDocVersionRequest) FromSignedProjectOptions(o sharedTypes.ProjectOptions)

type Update

type Update struct {
	Meta DocUpdateMeta              `json:"meta"`
	Docs map[string]DocUpdateBounds `json:"docs"`
}