post

Documentation

Index

• Variables
• func Followers(c echo.Context) error
• func GetOne(c echo.Context) error
• func IdAll(c echo.Context) error
• func IdBatch(c echo.Context) error
• func IdOwn(c echo.Context) error
• func Template(c echo.Context) error
• func Upload(c echo.Context) error
• type Paragraph
• type Post
  • func (m Post) String() string

Variables

var (
	CancelES context.CancelFunc
)

Functions

func Followers

func Followers(c echo.Context) error

@Title get a Post follower-Post ids @Summary get a specified Post follower-Post id group. @Description @Tags Post @Accept json @Produce json @Param followee query string true "followee Post ID" @Success 200 "OK - get successfully" @Failure 404 "Fail - empty follower ids" @Failure 500 "Fail - internal error" @Router /api/post/follower/ids [get] @Security ApiKeyAuth

func GetOne

func GetOne(c echo.Context) error

@Title get one Post content @Summary get one Post content. @Description @Tags Post @Accept json @Produce json @Param id query string true "Post ID for its content" @Success 200 "OK - get successfully" @Failure 400 "Fail - incorrect query param id" @Failure 404 "Fail - not found" @Failure 500 "Fail - internal error" @Router /api/post/one [get] @Security ApiKeyAuth

func IdAll

func IdAll(c echo.Context) error

@Title get all Post id group @Summary get all Post id group. @Description @Tags Post @Accept json @Produce json @Success 200 "OK - get successfully" @Failure 404 "Fail - empty event ids" @Failure 500 "Fail - internal error" @Router /api/post/ids-all [get] @Security ApiKeyAuth

func IdBatch

func IdBatch(c echo.Context) error

@Title get a batch of Post id group @Summary get a batch of Post id group. @Description @Tags Post @Accept json @Produce json @Param fetchby query string true "time or count" @Param value query string true "recent [value] minutes for time OR most recent [value] count" @Success 200 "OK - get successfully" @Failure 400 "Fail - incorrect query param type" @Failure 404 "Fail - not found" @Failure 500 "Fail - internal error" @Router /api/post/ids [get] @Security ApiKeyAuth

func IdOwn

func IdOwn(c echo.Context) error

@Title get own Post id group in a specific period @Summary get own Post id group in one specific time period. @Description @Tags Post @Accept json @Produce json @Param period query string false "time period for query, format is 'yyyymm', e.g. '202206'. if missing, current yyyymm applies" @Success 200 "OK - get successfully" @Failure 400 "Fail - incorrect query param type" @Failure 404 "Fail - empty event ids" @Failure 500 "Fail - internal error" @Router /api/post/own/ids [get] @Security ApiKeyAuth

func Template

func Template(c echo.Context) error

@Title Post template @Summary get Post template for dev reference. @Description @Tags Post @Accept json @Produce json @Success 200 "OK - upload successfully" @Router /api/post/template [get] @Security ApiKeyAuth

func Upload

func Upload(c echo.Context) error

@Title upload a Post @Summary upload a Post by filling a Post template. @Description @Tags Post @Accept json @Produce json @Param data body string true "filled Post template json file" @Param followee query string false "followee Post ID (empty when doing a new post)" @Success 200 "OK - upload successfully" @Failure 400 "Fail - incorrect Post format" @Failure 500 "Fail - internal error" @Router /api/post/upload post @Security ApiKeyAuth

Types

type Paragraph

type Paragraph struct {
	Text string `json:"text"`
	Path string `json:"path"`
}

type Post

type Post struct {
	Category string      `json:"category"`
	Topic    string      `json:"topic"`
	Content  []Paragraph `json:"content"`
	Summary  string      `json:"summary"`
}

func (Post) String

func (m Post) String() string