Documentation
¶
Overview ¶
Package server provides Syndication's REST API. See docs/API_refrence.md for more information on server requests and responses
Index ¶
- Constants
- type EntryQueryParams
- type ErrorResp
- type Server
- func (s *Server) AddFeedsToCategory(c echo.Context) error
- func (s *Server) DeleteCategory(c echo.Context) error
- func (s *Server) DeleteFeed(c echo.Context) error
- func (s *Server) EditCategory(c echo.Context) error
- func (s *Server) EditFeed(c echo.Context) error
- func (s *Server) GetCategories(c echo.Context) error
- func (s *Server) GetCategory(c echo.Context) error
- func (s *Server) GetEntries(c echo.Context) error
- func (s *Server) GetEntriesFromCategory(c echo.Context) error
- func (s *Server) GetEntriesFromFeed(c echo.Context) error
- func (s *Server) GetEntry(c echo.Context) error
- func (s *Server) GetFeed(c echo.Context) error
- func (s *Server) GetFeeds(c echo.Context) error
- func (s *Server) GetFeedsFromCategory(c echo.Context) error
- func (s *Server) GetStatsForCategory(c echo.Context) error
- func (s *Server) GetStatsForEntries(c echo.Context) error
- func (s *Server) GetStatsForFeed(c echo.Context) error
- func (s *Server) Login(c echo.Context) error
- func (s *Server) MarkCategory(c echo.Context) error
- func (s *Server) MarkEntry(c echo.Context) error
- func (s *Server) MarkFeed(c echo.Context) error
- func (s *Server) NewCategory(c echo.Context) error
- func (s *Server) NewFeed(c echo.Context) error
- func (s *Server) Register(c echo.Context) error
- func (s *Server) Start() error
- func (s *Server) Stop() error
Constants ¶
const DefaultPort = "80"
DefaultPort server binds to
const DefaultTLSPort = "443"
DefaultTLSPort server binds to if TLS is enabled
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EntryQueryParams ¶
type EntryQueryParams struct {
Update bool `query:"update"`
Marker string `query:"withMarker"`
Saved bool `query:"saved"`
}
EntryQueryParams maps query parameters used when GETting entries resources
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server represents a echo server instance and holds references to other components needed for the REST API handlers.
func (*Server) AddFeedsToCategory ¶
AddFeedsToCategory adds a Feed to a Category with id
func (*Server) DeleteCategory ¶
DeleteCategory with id
func (*Server) EditCategory ¶
EditCategory with id
func (*Server) GetCategories ¶
GetCategories returns a list of Categories owned by a user
func (*Server) GetEntries ¶
GetEntries returns a list of entries that belong to a user
func (*Server) GetEntriesFromCategory ¶
GetEntriesFromCategory returns a list of Entries that belong to a Feed that belongs to a Category
func (*Server) GetEntriesFromFeed ¶
GetEntriesFromFeed returns a list of entries provided from a feed
func (*Server) GetFeedsFromCategory ¶
GetFeedsFromCategory returns a list of Feeds that belong to a Category
func (*Server) GetStatsForCategory ¶
GetStatsForCategory returns statistics related to a Category
func (*Server) GetStatsForEntries ¶
GetStatsForEntries provides statistics related to Entries
func (*Server) GetStatsForFeed ¶
GetStatsForFeed provides statistics related to a Feed
func (*Server) MarkCategory ¶
MarkCategory applies a Marker to a Category
func (*Server) NewCategory ¶
NewCategory creates a new Category
Source Files