model

Documentation

Overview

Package model contains the model definitions for mouthful API response and request types.

Index

• type CreateCommentBody
• type CreateCommentResponse
• type DeleteCommentBody
• type LoginBody
• type UpdateCommentBody

Types

type CreateCommentBody

type CreateCommentBody struct {
	Path    string  `json:"path"`
	Body    string  `json:"body"`
	Author  string  `json:"author"`
	Email   *string `json:"email,omitempty"`
	ReplyTo *string `json:"replyTo,omitempty"`
}

CreateCommentBody is a struct that represents a create comment request

type CreateCommentResponse

type CreateCommentResponse struct {
	Id      string  `json:"id"`
	Path    string  `json:"path"`
	Body    string  `json:"body"`
	Author  string  `json:"author"`
	Email   *string `json:"email,omitempty"`
	ReplyTo *string `json:"replyTo,omitempty"`
}

CreateCommentResponse is a struct that represents a create comment response

type DeleteCommentBody

type DeleteCommentBody struct {
	CommentId string `json:"commentId"`
	Hard      bool   `json:"hard"`
}

DeleteCommentBody is a struct that represents a delete comment request

type LoginBody

type LoginBody struct {
	Password string `json:"password"`
}

LoginBody is a struct that represents a login request

type UpdateCommentBody

type UpdateCommentBody struct {
	CommentId string  `json:"commentId"`
	Body      *string `json:"body,omitempty"`
	Author    *string `json:"author,omitempty"`
	Confirmed *bool   `json:"confirmed,omitempty"`
}

UpdateCommentBody is a struct that represents an update comment request