Documentation
¶
Index ¶
- func InitHandlersAndRoutes(envConfig *viper.Viper) http.Handler
- type FriendsAPI
- func (f *FriendsAPI) PostFriendsCommonList(ctx context.Context, params friends.PostFriendsCommonListParams) middleware.Responder
- func (f *FriendsAPI) PostFriendsConnections(ctx context.Context, params friends.PostFriendsConnectionsParams) middleware.Responder
- func (f *FriendsAPI) PostFriendsConnectionsList(ctx context.Context, params friends.PostFriendsConnectionsListParams) middleware.Responder
- func (f *FriendsAPI) PostFriendsUpdatesBlock(ctx context.Context, params friends.PostFriendsUpdatesBlockParams) middleware.Responder
- func (f *FriendsAPI) PostFriendsUpdatesList(ctx context.Context, params friends.PostFriendsUpdatesListParams) middleware.Responder
- func (f *FriendsAPI) PostFriendsUpdatesSubscribe(ctx context.Context, params friends.PostFriendsUpdatesSubscribeParams) middleware.Responder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type FriendsAPI ¶
type FriendsAPI struct {
// contains filtered or unexported fields
}
FriendsAPI ... Friends API implementation
func NewFriendsAPI ¶
func NewFriendsAPI(db *database.Database) *FriendsAPI
NewFriendsAPI ... Create New NewFriendsAPI
func (*FriendsAPI) PostFriendsCommonList ¶
func (f *FriendsAPI) PostFriendsCommonList(ctx context.Context, params friends.PostFriendsCommonListParams) middleware.Responder
PostFriendsCommonList is 3. As a user, I need an API to retrieve the common friends list between two email addresses.
func (*FriendsAPI) PostFriendsConnections ¶
func (f *FriendsAPI) PostFriendsConnections(ctx context.Context, params friends.PostFriendsConnectionsParams) middleware.Responder
PostFriendsConnections is 1. As a user, I need an API to create a friend connection between two email addresses.
func (*FriendsAPI) PostFriendsConnectionsList ¶
func (f *FriendsAPI) PostFriendsConnectionsList(ctx context.Context, params friends.PostFriendsConnectionsListParams) middleware.Responder
PostFriendsConnectionsList is 2. As a user, I need an API to retrieve the friends list for an email address.
func (*FriendsAPI) PostFriendsUpdatesBlock ¶
func (f *FriendsAPI) PostFriendsUpdatesBlock(ctx context.Context, params friends.PostFriendsUpdatesBlockParams) middleware.Responder
PostFriendsUpdatesBlock is 5. As a user, I need an API to block updates from an email address.</br> Suppose andy@example.com blocks john@example.com:</br> <ul> <li>if they are connected as friends, then andy will no longer receive notifications from john</li> <li>if they are not connected as friends, then no new friends connection can be added</li> </ul>
func (*FriendsAPI) PostFriendsUpdatesList ¶
func (f *FriendsAPI) PostFriendsUpdatesList(ctx context.Context, params friends.PostFriendsUpdatesListParams) middleware.Responder
PostFriendsUpdatesList is 6. As a user, I need an API to retrieve all email addresses that can receive updates from an email address.</br> Eligibility for receiving updates from i.e. john@example.com</br> <ul> <li>has not blocked updates from john@example.com, and</li> <li>at least one of the following:</li> <ul> <li>has a friend connection with john@example.com</li> <li>has subscribed to updates from john@example.com</li> <li>has been @mentioned in the update</li> </ul> </ul>
func (*FriendsAPI) PostFriendsUpdatesSubscribe ¶
func (f *FriendsAPI) PostFriendsUpdatesSubscribe(ctx context.Context, params friends.PostFriendsUpdatesSubscribeParams) middleware.Responder
PostFriendsUpdatesSubscribe is 4. As a user, I need an API to subscribe to updates from an email address.</br> Please note that subscribing to updates is NOT equivalent to adding a friend connection
Source Files