rest

package
v0.0.0-...-dc8ef24 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 7, 2021 License: AGPL-3.0 Imports: 9 Imported by: 0

Documentation

Overview

Package controller provides Syndication's REST API. See docs/API_reference.md for more information on controller requests and responses

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthController 

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

func NewAuthController 

func NewAuthController(service services.Auth, secret string, allowRegistration bool, e *echo.Echo) *AuthController

func (*AuthController) Login 

func (s *AuthController) Login(c echo.Context) error

Login a user

func (*AuthController) Register 

func (s *AuthController) Register(c echo.Context) error

Register a user

func (*AuthController) Renew 

func (s *AuthController) Renew(c echo.Context) error

Renew an API Token

type CategoriesController 

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

func NewCategoriesController 

func NewCategoriesController(service services.Categories, e *echo.Echo) *CategoriesController

func (*CategoriesController) AppendCategoryFeeds 

func (s *CategoriesController) AppendCategoryFeeds(c echo.Context) error

AppendCategoryFeeds adds a Feed to a Categories with id

func (*CategoriesController) DeleteCategory 

func (s *CategoriesController) DeleteCategory(c echo.Context) error

DeleteCategory with id

func (*CategoriesController) EditCategory 

func (s *CategoriesController) EditCategory(c echo.Context) error

EditCategory with id

func (*CategoriesController) GetCategories 

func (s *CategoriesController) GetCategories(c echo.Context) error

GetCategories returns a list of Categories owned by a user

func (*CategoriesController) GetCategory 

func (s *CategoriesController) GetCategory(c echo.Context) error

GetCategory with id

func (*CategoriesController) GetCategoryEntries 

func (s *CategoriesController) GetCategoryEntries(c echo.Context) error

GetCategoryEntries returns a list of Entries that belong to a Feed that belongs to a Categories

func (*CategoriesController) GetCategoryFeeds 

func (s *CategoriesController) GetCategoryFeeds(c echo.Context) error

GetCategoryFeeds returns a list of Feeds that belong to a Categories

func (*CategoriesController) GetCategoryStats 

func (s *CategoriesController) GetCategoryStats(c echo.Context) error

GetCategoryStats returns statistics related to a Categories

func (*CategoriesController) MarkCategory 

func (s *CategoriesController) MarkCategory(c echo.Context) error

MarkCategory applies a Marker to a Categories

func (*CategoriesController) NewCategory 

func (s *CategoriesController) NewCategory(c echo.Context) error

NewCategory creates a new Categories

type Controller 

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

type EntriesController 

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

func NewEntriesController 

func NewEntriesController(service services.Entries, e *echo.Echo) *EntriesController

func (*EntriesController) GetEntries 

func (s *EntriesController) GetEntries(c echo.Context) error

GetEntries returns a list of entries that belong to a user

func (*EntriesController) GetEntry 

func (s *EntriesController) GetEntry(c echo.Context) error

GetEntry with id

func (*EntriesController) GetEntryStats 

func (s *EntriesController) GetEntryStats(c echo.Context) error

GetEntryStats provides statistics related to Entries

func (*EntriesController) MarkAllEntries 

func (s *EntriesController) MarkAllEntries(c echo.Context) error

MarkAllEntries applies a Marker to all Entries

func (*EntriesController) MarkEntry 

func (s *EntriesController) MarkEntry(c echo.Context) error

MarkEntry applies a Marker to an Entries

type ExporterController 

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

func NewExporterController 

func NewExporterController(exporters Exporters, e *echo.Echo) *ExporterController

func (*ExporterController) Export 

func (s *ExporterController) Export(c echo.Context) error

Export feeds and categories out of Syndication. Accept header must be set to a supported MIME type. The current supported formats are:

  • OPML (text/xml)

type Exporters 

type Exporters = map[string]services.Exporter

type FeedsController 

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

func NewFeedsController 

func NewFeedsController(service services.Feeds, e *echo.Echo) *FeedsController

func (*FeedsController) DeleteFeed 

func (s *FeedsController) DeleteFeed(c echo.Context) error

DeleteFeed with id

func (*FeedsController) EditFeed 

func (s *FeedsController) EditFeed(c echo.Context) error

EditFeed with id

func (*FeedsController) GetFeed 

func (s *FeedsController) GetFeed(c echo.Context) error

GetFeed with id

func (*FeedsController) GetFeedEntries 

func (s *FeedsController) GetFeedEntries(c echo.Context) error

GetFeedEntries returns a list of entries provided from a feed

func (*FeedsController) GetFeedStats 

func (s *FeedsController) GetFeedStats(c echo.Context) error

GetFeedStats provides statistics related to a Feed

func (*FeedsController) GetFeeds 

func (s *FeedsController) GetFeeds(c echo.Context) error

GetFeeds returns a list of subscribed feeds

func (*FeedsController) MarkFeed 

func (s *FeedsController) MarkFeed(c echo.Context) error

MarkFeed applies a Marker to a Feed

func (*FeedsController) NewFeed 

func (s *FeedsController) NewFeed(c echo.Context) error

NewFeed creates a new feed

type ImporterController 

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

func NewImporterController 

func NewImporterController(importers Importers, e *echo.Echo) *ImporterController

func (*ImporterController) Import 

func (s *ImporterController) Import(c echo.Context) error

Import feeds and categories into Syndication. Content-Type header must be set to a supported MIME type. The current supported formats are:

  • OPML (text/xml)

type Importers 

type Importers = map[string]services.Importer

type TagsController 

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

func NewTagsController 

func NewTagsController(service services.Tags, e *echo.Echo) *TagsController

func (*TagsController) DeleteTag 

func (s *TagsController) DeleteTag(c echo.Context) error

DeleteTag with id

func (*TagsController) GetEntriesFromTag 

func (s *TagsController) GetEntriesFromTag(c echo.Context) error

GetEntriesFromTag returns a list of Entries that are tagged by a Tag with ID

func (*TagsController) GetTag 

func (s *TagsController) GetTag(c echo.Context) error

GetTag with id

func (*TagsController) GetTags 

func (s *TagsController) GetTags(c echo.Context) error

GetTags returns a list of Tags owned by a user

func (*TagsController) NewTag 

func (s *TagsController) NewTag(c echo.Context) error

NewTag creates a new Tag

func (*TagsController) TagEntries 

func (s *TagsController) TagEntries(c echo.Context) error

TagEntries adds a Tag with tagID to a list of entries

func (*TagsController) UpdateTag 

func (s *TagsController) UpdateTag(c echo.Context) error

UpdateTag with id

type UsersController 

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

func NewUsersController 

func NewUsersController(service services.Users, e *echo.Echo) *UsersController

func (*UsersController) DeleteUser 

func (c *UsersController) DeleteUser(ctx echo.Context) error

func (*UsersController) GetUser 

func (c *UsersController) GetUser(ctx echo.Context) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.