rest

Documentation

Index

• Constants
• func RegisterRoutes(cliCtx client.Context, r *mux.Router)
• type AddReactionReq
• type AnswerPollPostReq
• type CreatePostReq
• type RegisterReactionReq
• type RemoveReactionReq

Constants

const (
	ParamPostID = "post_id"

	ParamSortBy       = "sort_by"
	ParamSortOrder    = "sort_order"
	ParamParentID     = "parent_id"
	ParamCreationTime = "creation_time"
	ParamSubspace     = "subspace"
	ParamCreator      = "creator"
	ParamHashtags     = "hashtags"
)

Functions

func RegisterRoutes

func RegisterRoutes(cliCtx client.Context, r *mux.Router)

RegisterRoutes - Central function to define routes that get registered by the main application

Types

type AddReactionReq

type AddReactionReq struct {
	BaseReq  rest.BaseReq `json:"base_req"`
	PostID   string       `json:"post_id"`
	Reaction string       `json:"reaction"`
}

AddReactionReq defines the properties of a reaction adding request's body.

type AnswerPollPostReq

type AnswerPollPostReq struct {
	BaseReq rest.BaseReq `json:"base_req"`
	Answers []string     `json:"answers"`
}

type CreatePostReq

type CreatePostReq struct {
	BaseReq        rest.BaseReq       `json:"base_req"`
	Message        string             `json:"message"`
	ParentID       string             `json:"parent_id"`
	AllowsComments bool               `json:"allows_comments"`
	Subspace       string             `json:"subspace"`
	OptionalData   types.OptionalData `json:"optional_data"`
	CreationTime   time.Time          `json:"creation_time"`
	Medias         types.Attachments  `json:"attachments,omitempty"`
	PollData       *types.PollData    `json:"poll_data,omitempty"`
}

CreatePostReq defines the properties of a post creation request's body.

type RegisterReactionReq

type RegisterReactionReq struct {
	BaseReq   rest.BaseReq `json:"base_req"`
	Shortcode string       `json:"shortcode"`
	Value     string       `json:"value"`
	Subspace  string       `json:"subspace"`
}

type RemoveReactionReq

type RemoveReactionReq struct {
	BaseReq  rest.BaseReq `json:"base_req"`
	PostID   string       `json:"post_id"`
	Reaction string       `json:"reaction"`
}

RemoveReactionReq defines the properties of a reaction removal request's body.