model

Documentation

Index

• type Note
• type Notebook
• type NotebookCreate
• type NotebookCreateResponse

Types

type Note

type Note struct {
	// The note ID
	//
	// Required. Expected to be an UUID.
	ID string `json:"id"`
	// ID of the notebook the note belongs to
	//
	// Required. Foreign key in database
	NotebookID string `json:"notebook_id"`
	// Note title
	//
	// Required.
	Title string `json:"title"`
	// Note order.
	//
	// Required.
	Order uint `json:"order"`
	// Note contents
	//
	// Optional. Markdown formatted.
	Content string `json:"content"`
	// Created at timestamp.
	//
	// Required.
	CreatedAt time.Time `json:"created_at"`
	// Updated at timestamp.
	//
	// Required.
	UpdatedAt time.Time `json:"updated_at"`
}

Note Model

type Notebook

type Notebook struct {
	// The notebook ID.
	//
	// Required. Expected to be a string generated by Yeast. (db: SERIAL)
	ID string `json:"id"`
	// Name of the notebook
	//
	// Optional.
	Name string `json:"name"`
	// Password to gain privileged access to the notebook.
	//
	// Optional. Encoded.
	Password string `json:"-"`
	// Protection level.
	//
	// Enum - possible values: "none" | "readonly" | "protected" (0 | 1 | 2) (db: enum)
	//
	// None | 0 - everyone has access
	//
	// ReadOnly | 1 - read only. password needed to write
	//
	// Protected | 2 - protected. password needed to read
	//
	// Required.
	ProtectionLevel auth.ProtectionLevel `json:"protection_level"`
	// Created at timestamp.
	//
	// Required.
	CreatedAt time.Time `json:"created_at"`
	// Updated at timestamp.
	//
	// Required.
	UpdatedAt time.Time `json:"updated_at"`
	// Notes
	//
	// Optional.
	Notes []Note `json:"notes"`
}

Notebook Model

type NotebookCreate

type NotebookCreate struct {
	// Name of the notebook.
	Name string `json:"name"`
	// Protection level.
	//
	// Enum - possible values: "none" | "readonly" | "protected" (0 | 1 | 2) (db: enum)
	//
	// None | 0 - everyone has access
	//
	// ReadOnly | 1 - read only. password needed to write
	//
	// Protected | 2 - protected. password needed to read
	//
	// Required.
	ProtectionLevel auth.ProtectionLevel `json:"protection_level"`
	// Password (unencoded)
	Password string `json:"password"`
}

type NotebookCreateResponse

type NotebookCreateResponse struct {
	// Assigned ID
	ID string `json:"id"`
	// Response information
	util.Response
}