dto

Documentation

Index

• type DocumentRequestDTO
• type DocumentResponseDTO
• type FolderResponseDTO
• type HistoryDTO

Types

type DocumentRequestDTO

type DocumentRequestDTO struct {
	// ID is the unique identifier of the document.
	ID string `json:"id"`
	// Name is the name of the document.
	Name string `json:"name"`
	// Content is the content of the document.
	Path string `json:"path"`
	// Content is the content of the document.
	Content string `json:"content"`
}

DocumentRequestDTO represents the struct that is accepted as input for the rest endpoint

type DocumentResponseDTO

type DocumentResponseDTO struct {

	// ID is the unique identifier of the document.
	ID string `json:"id"`
	// Name is the name of the document.
	Name string `json:"name"`
	// Content is the content of the document.
	Content string `json:"content"`
	// Path is the path of the document.
	Path string `json:"path"`
	// DocumentHistory is the history of the document.
	DocumentHistory []HistoryDTO `json:"documentHistory"`
}

DocumentResponseDTO represents the struct that is returned by rest endpoints

type FolderResponseDTO

type FolderResponseDTO struct {
	// ID is the unique identifier of the folder.
	ID string `json:"id"`
	// Name is the name of the folder.
	Name string `json:"name"`
	// ParentFolderID is the unique identifier of the parent folder.
	ParentFolderID string `json:"parentFolderID,omitEmpty"`
	// Folders is the list of folders in the folder.
	// Folders is the list of folders in the folder.
	Folders []FolderResponseDTO `json:"folders,omitEmpty"`
	// Documents is the list of documents in the folder.
	Documents []DocumentResponseDTO `json:"documents,omitEmpty"`
}

type HistoryDTO

type HistoryDTO struct {
	// EditedBy is the user who edited the document.
	EditedBy string `json:"editedBy"`
	// EditedAt is the date when the document was edited.
	EditedAt time.Time `json:"editedAt"`
}