api

Documentation

Overview

Package api implements API endpoints for Miniflux application.

Index

• type Controller
  • func NewController(store *storage.Storage, feedHandler *feed.Handler) *Controller
  • func (c *Controller) CreateCategory(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) CreateFeed(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) CreateUser(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) Export(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) FeedIcon(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) GetCategories(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) GetEntries(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) GetEntry(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) GetFeed(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) GetFeedEntries(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) GetFeedEntry(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) GetFeeds(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) GetSubscriptions(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) RefreshFeed(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) RemoveCategory(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) RemoveFeed(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) RemoveUser(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) SetEntryStatus(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) ToggleBookmark(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) UpdateCategory(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) UpdateFeed(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) UpdateUser(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) UserByID(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) UserByUsername(ctx *handler.Context, request *handler.Request, response *handler.Response)
  • func (c *Controller) Users(ctx *handler.Context, request *handler.Request, response *handler.Response)

Types

type Controller

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

Controller holds all handlers for the API.

func NewController

func NewController(store *storage.Storage, feedHandler *feed.Handler) *Controller

NewController creates a new controller.

func (*Controller) CreateCategory

func (c *Controller) CreateCategory(ctx *handler.Context, request *handler.Request, response *handler.Response)

CreateCategory is the API handler to create a new category.

func (*Controller) CreateFeed

func (c *Controller) CreateFeed(ctx *handler.Context, request *handler.Request, response *handler.Response)

CreateFeed is the API handler to create a new feed.

func (*Controller) CreateUser

func (c *Controller) CreateUser(ctx *handler.Context, request *handler.Request, response *handler.Response)

CreateUser is the API handler to create a new user.

func (*Controller) Export

func (c *Controller) Export(ctx *handler.Context, request *handler.Request, response *handler.Response)

Export is the API handler that incoves an OPML export.

func (*Controller) FeedIcon

func (c *Controller) FeedIcon(ctx *handler.Context, request *handler.Request, response *handler.Response)

FeedIcon returns a feed icon.

func (*Controller) GetCategories

func (c *Controller) GetCategories(ctx *handler.Context, request *handler.Request, response *handler.Response)

GetCategories is the API handler to get a list of categories for a given user.

func (*Controller) GetEntries

func (c *Controller) GetEntries(ctx *handler.Context, request *handler.Request, response *handler.Response)

GetEntries is the API handler to fetch entries.

func (*Controller) GetEntry

func (c *Controller) GetEntry(ctx *handler.Context, request *handler.Request, response *handler.Response)

GetEntry is the API handler to get a single entry.

func (*Controller) GetFeed

func (c *Controller) GetFeed(ctx *handler.Context, request *handler.Request, response *handler.Response)

GetFeed is the API handler to get a feed.

func (*Controller) GetFeedEntries

func (c *Controller) GetFeedEntries(ctx *handler.Context, request *handler.Request, response *handler.Response)

GetFeedEntries is the API handler to get all feed entries.

func (*Controller) GetFeedEntry

func (c *Controller) GetFeedEntry(ctx *handler.Context, request *handler.Request, response *handler.Response)

GetFeedEntry is the API handler to get a single feed entry.

func (*Controller) GetFeeds

func (c *Controller) GetFeeds(ctx *handler.Context, request *handler.Request, response *handler.Response)

GetFeeds is the API handler that get all feeds that belongs to the given user.

func (*Controller) GetSubscriptions

func (c *Controller) GetSubscriptions(ctx *handler.Context, request *handler.Request, response *handler.Response)

GetSubscriptions is the API handler to find subscriptions.

func (*Controller) RefreshFeed

func (c *Controller) RefreshFeed(ctx *handler.Context, request *handler.Request, response *handler.Response)

RefreshFeed is the API handler to refresh a feed.

func (*Controller) RemoveCategory

func (c *Controller) RemoveCategory(ctx *handler.Context, request *handler.Request, response *handler.Response)

RemoveCategory is the API handler to remove a category.

func (*Controller) RemoveFeed

func (c *Controller) RemoveFeed(ctx *handler.Context, request *handler.Request, response *handler.Response)

RemoveFeed is the API handler to remove a feed.

func (*Controller) RemoveUser

func (c *Controller) RemoveUser(ctx *handler.Context, request *handler.Request, response *handler.Response)

RemoveUser is the API handler to remove an existing user.

func (*Controller) SetEntryStatus

func (c *Controller) SetEntryStatus(ctx *handler.Context, request *handler.Request, response *handler.Response)

SetEntryStatus is the API handler to change the status of entries.

func (*Controller) ToggleBookmark

func (c *Controller) ToggleBookmark(ctx *handler.Context, request *handler.Request, response *handler.Response)

ToggleBookmark is the API handler to toggle bookmark status.

func (*Controller) UpdateCategory

func (c *Controller) UpdateCategory(ctx *handler.Context, request *handler.Request, response *handler.Response)

UpdateCategory is the API handler to update a category.

func (*Controller) UpdateFeed

func (c *Controller) UpdateFeed(ctx *handler.Context, request *handler.Request, response *handler.Response)

UpdateFeed is the API handler that is used to update a feed.

func (*Controller) UpdateUser

func (c *Controller) UpdateUser(ctx *handler.Context, request *handler.Request, response *handler.Response)

UpdateUser is the API handler to update the given user.

func (*Controller) UserByID

func (c *Controller) UserByID(ctx *handler.Context, request *handler.Request, response *handler.Response)

UserByID is the API handler to fetch the given user by the ID.

func (*Controller) UserByUsername

func (c *Controller) UserByUsername(ctx *handler.Context, request *handler.Request, response *handler.Response)

UserByUsername is the API handler to fetch the given user by the username.

func (*Controller) Users

func (c *Controller) Users(ctx *handler.Context, request *handler.Request, response *handler.Response)

Users is the API handler to get the list of users.