api

Documentation

Overview

Package classification justlog API

https://github.com/gempir/justlog

Schemes: https
BasePath: /

Consumes:
- application/json
- application/xml

Produces:
- application/json
- text/plain

SecurityDefinitions:
api_key:
     type: apiKey
     name: X-Api-Key
     in: header

swagger:meta

Index

• type AddChannelsParameters
• type AllChannelsJSON
• type ChannelIdLogsParams
• type ChannelIdLogsYearMonthDayParams
• type ChannelIdUserIdLogsParams
• type ChannelIdUserIdLogsRandomParams
• type ChannelIdUserIdLogsYearMonthParams
• type ChannelIdUserLogsParams
• type ChannelIdUserLogsRandomParams
• type ChannelIdUserLogsYearMonthParams
• type ChannelLogsParams
• type ChannelLogsYearMonthDayParams
• type ChannelUserIdLogsParams
• type ChannelUserIdLogsRandomParams
• type ChannelUserIdLogsYearMonthParams
• type ChannelUserLogsParams
• type ChannelUserLogsRandomParams
• type ChannelUserLogsYearMonthParams
• type DeleteChannelsParameters
• type ErrorResponse
• type ListLogsParams
• type LogParams
• type RandomChannelQuoteJSON
• type RandomQuoteJSON
• type Server
  • func NewServer(cfg *config.Config, bot *bot.Bot, fileLogger filelog.Logger, ...) Server
  • func (s *Server) Init()

Types

type AddChannelsParameters

type AddChannelsParameters struct {
	// in:body
	Body channelConfigsJoinRequest
}

swagger:parameters addChannels

type AllChannelsJSON

type AllChannelsJSON struct {
	Channels []channel `json:"channels"`
}

swagger:model

type ChannelIdLogsParams

type ChannelIdLogsParams struct {
	// in: path
	Channel string `json:"channelid"`
	LogParams
}

type ChannelIdLogsYearMonthDayParams

type ChannelIdLogsYearMonthDayParams struct {
	// in: path
	Channel string `json:"channel"`
	// in: path
	Year string `json:"year"`
	// in: path
	Month string `json:"month"`
	// in: path
	Day string `json:"day"`
	LogParams
}

type ChannelIdUserIdLogsParams

type ChannelIdUserIdLogsParams struct {
	// in: path
	ChannelId string `json:"channelid"`
	// in: path
	UserId string `json:"userid"`
	LogParams
}

type ChannelIdUserIdLogsRandomParams

type ChannelIdUserIdLogsRandomParams struct {
	// in: path
	ChannelId string `json:"channelid"`
	// in: path
	UserId string `json:"userid"`
	LogParams
}

type ChannelIdUserIdLogsYearMonthParams

type ChannelIdUserIdLogsYearMonthParams struct {
	// in: path
	ChannelId string `json:"channelid"`
	// in: path
	UserId string `json:"userid"`
	// in: path
	Year string `json:"year"`
	// in: path
	Month string `json:"month"`
	LogParams
}

type ChannelIdUserLogsParams

type ChannelIdUserLogsParams struct {
	// in: path
	ChannelId string `json:"channelid"`
	// in: path
	Username string `json:"username"`
	LogParams
}

type ChannelIdUserLogsRandomParams

type ChannelIdUserLogsRandomParams struct {
	// in: path
	ChannelId string `json:"channelid"`
	// in: path
	Username string `json:"username"`
	LogParams
}

type ChannelIdUserLogsYearMonthParams

type ChannelIdUserLogsYearMonthParams struct {
	// in: path
	ChannelId string `json:"channelid"`
	// in: path
	Username string `json:"username"`
	// in: path
	Year string `json:"year"`
	// in: path
	Month string `json:"month"`
	LogParams
}

type ChannelLogsParams

type ChannelLogsParams struct {
	// in: path
	Channel string `json:"channel"`
	LogParams
}

type ChannelLogsYearMonthDayParams

type ChannelLogsYearMonthDayParams struct {
	// in: path
	Channel string `json:"channel"`
	// in: path
	Year string `json:"year"`
	// in: path
	Month string `json:"month"`
	// in: path
	Day string `json:"day"`
	LogParams
}

type ChannelUserIdLogsParams

type ChannelUserIdLogsParams struct {
	// in: path
	Channel string `json:"channel"`
	// in: path
	UserId string `json:"userid"`
	LogParams
}

type ChannelUserIdLogsRandomParams

type ChannelUserIdLogsRandomParams struct {
	// in: path
	Channel string `json:"channel"`
	// in: path
	UserId string `json:"userid"`
	LogParams
}

type ChannelUserIdLogsYearMonthParams

type ChannelUserIdLogsYearMonthParams struct {
	// in: path
	Channel string `json:"channel"`
	// in: path
	Userid string `json:"userid"`
	// in: path
	Year string `json:"year"`
	// in: path
	Month string `json:"month"`
	LogParams
}

type ChannelUserLogsParams

type ChannelUserLogsParams struct {
	// in: path
	Channel string `json:"channel"`
	// in: path
	Username string `json:"username"`
	LogParams
}

type ChannelUserLogsRandomParams

type ChannelUserLogsRandomParams struct {
	// in: path
	Channel string `json:"channel"`
	// in: path
	Username string `json:"username"`
	LogParams
}

type ChannelUserLogsYearMonthParams

type ChannelUserLogsYearMonthParams struct {
	// in: path
	Channel string `json:"channel"`
	// in: path
	Username string `json:"username"`
	// in: path
	Year string `json:"year"`
	// in: path
	Month string `json:"month"`
	LogParams
}

type DeleteChannelsParameters

type DeleteChannelsParameters struct {
	// in:body
	Body channelsDeleteRequest
}

swagger:parameters deleteChannels

type ErrorResponse

type ErrorResponse struct {
	Message string `json:"message"`
}

ErrorResponse a simple error response

type ListLogsParams

type ListLogsParams struct {
	// in: query
	Channel string `json:"channel"`
	// in: query
	Username string `json:"username"`
	// in: query
	ChannelId string `json:"channelid"`
	// in: query
	Userid string `json:"userid"`
}

type LogParams

type LogParams struct {
	// in: query
	Json string `json:"json"`
	// in: query
	Reverse string `json:"reverse"`
	// in: query
	From int32 `json:"from"`
	// in: query
	To int32 `json:"to"`
}

type RandomChannelQuoteJSON

type RandomChannelQuoteJSON struct {
	Channel     string    `json:"channel"`
	Username    string    `json:"username"`
	DisplayName string    `json:"displayName"`
	Message     string    `json:"message"`
	Timestamp   timestamp `json:"timestamp"`
}

RandomQuoteJSON response when request a random message

type RandomQuoteJSON

type RandomQuoteJSON struct {
	Channel     string    `json:"channel"`
	Username    string    `json:"username"`
	DisplayName string    `json:"displayName"`
	Message     string    `json:"message"`
	Timestamp   timestamp `json:"timestamp"`
}

RandomQuoteJSON response when request a random message

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server api server

func NewServer

func NewServer(cfg *config.Config, bot *bot.Bot, fileLogger filelog.Logger, helixClient helix.TwitchApiClient, assets fs.FS) Server

NewServer create api Server

func (*Server) Init

func (s *Server) Init()

Init start the server