package
0.0.0-20240414174107-f7ec041e7514
Repository: https://github.com/nerdzeu/nerdz-api.git
Documentation: pkg.go.dev
# Functions
GetProjectInfo returns the *ProjectInfo of the project.
GetProjectsInfo returns a slice of *Interfations.
GetUserInfo returns the *UserInfo of the user.
GetUsersInfo returns a slice of *Interfations.
InvalidScopeResponse prints a JSON response and returns a error asserting that the required scope is missing from the accepted scopes.
IsGranted returns true if the c.Get("scopes") slice contains the scope or there's a compatible scope into the slice.
Project extract "id" from the url parameter, parse it and returns the Project if the "me" (in the context) user is allowed to see it.
SelectFields changes the json part of struct tags of in interface{} (that must by a struct or a slice of structs with the right json tags) Selecting only specified fields (in the query string "fields" value).
User extract "id" from the url parameter, parse it and returns the User if the "me" (in the context) user is allowed to see it.
# Structs
CommentID is the ID of the comment
swagger:parameters GetUserPostComment EditUserPostComment DeleteUserPostComment GetUserPostCommentsVotes NewUserPostCommentVote DeleteMePostComment DeleteMePost EditMeComment GetMePostCommentsVotes NewMePostCommentVote GetProjectPostComment EditProjectPostComment DeleteProjectPostComment GetProjectPostCommentsVotes NewProjectPostCommentVote GetMePostComment.
ID is the ID of the referenced board, user or project
swagger:parameters GetUserPosts GetUserPost NewUserPost DeleteUserPost EditUserPost GetUserPostComments GetUserPostComment NewUserPostComment EditUserPostComment DeleteUserPostComment GetUserInfo GetUserFriends GetUserFollowers GetUserFollowing GetProjectFollowing GetWhitelist GetWhitelisting GetBlacklist GetBlacklisting GetUserPostVotes NewUserPostVote GetUserPostCommentsVotes NewUserPostCommentVote GetUserPostBookmarks NewUserPostBookmark DeleteUserPostBookmark GetUserPostLurks NewUserPostLurk DeleteUserPostLurk GetUserPostLock NewUserPostLock DeleteUserPostLock NewUserNewPostUserLock DeleteUserPostUserLock getProjectPosts getProjectPost NewProjectPost DeleteProjectPost EditProjectPost getProjectPostComments GetProjectPostComment NewProjectPostComment EditProjectPostComment DeleteProjectPostComment getProjectInfo getProjectMembers getProjectFollowers GetProjectPostVotes NewProjectPostVote GetProjectPostCommentsVotes NewProjectPostCommentVote GetProjectPostBookmarks NewProjectPostBookmark DeleteProjectPostBookmark GetProjectPostLurks NewProjectPostLurk DeleteProjectPostLurk GetProjectPostLock NewProjectPostLock DeleteProjectPostLock NewUserNewPostProjectLock DeleteProjectPostUserLock.
Me is a response
swagger:response Me.
MeBlacklist is a response
swagger:response MeBlacklist.
MeBlacklisting is a response
swagger:response MeBlacklisting.
MeFollowers is a response
swagger:response MeFollowers.
MeFollowingProjects is a response
swagger:response MeFollowingProjects.
MeFollowingUsers is a response
swagger:response MeFollowingUsers.
MeFriends is a response
swagger:response MeFriends.
MeHome is a response
swagger:response MeHome.
MePms is a response
swagger:response MePms.
MePmsOther is a response
swagger:response MePmsOther.
MePmsOtherPmid is a response
swagger:response MePmsOtherPmid.
MePosts is a response
swagger:response MePosts.
MePostsPid is a response
swagger:response MePostsPid.
MePostsPidBookmarks is a response
swagger:response MePostsPidBookmarks.
MePostsPidComments is a response
swagger:response MePostsPidComments.
MePostsPidCommentsCid is a response
swagger:response MePostsPidCommentsCid.
MePostsPidCommentsCidVotes is a response
swagger:response MePostsPidCommentsCidVotes.
MePostsPidLocks is a response
swagger:response MePostsPidLocks.
MePostsPidLurks is a response
swagger:response MePostsPidLurks.
MePostsPidVotes is a response
swagger:response MePostsPidVotes.
MeWhitelist is a response
swagger:response MeWhitelist.
MeWhitelisting is a response
swagger:response MeWhitelisting.
NewMessage represents a new message from the current user
swagger:parameters addMessage.
NewVote represent a new vote from the current user
swagger:parameters addVote.
OtherID is the ID of the other user
swagger:parameters getMeConversation DeleteMePms GetMePm NewMePm EditMePm DeleteMePm.
PmID is the ID of the PM
swagger:parameters GetMePm EditMePm DeleteMePm.
PostID is the post ID swagger parameter
swagger:parameters GetUserPost DeleteUserPost EditUserPost GetUserPostComments GetUserPostComment NewUserPostComment EditUserPostComment DeleteUserPostComment GetUserPostVotes NewUserPostVote GetUserPostCommentsVotes NewUserPostCommentVote GetUserPostBookmarks NewUserPostBookmark DeleteUserPostBookmark GetUserPostLurks NewUserPostLurk DeleteUserPostLurk GetUserPostLock NewUserPostLock DeleteUserPostLock NewUserNewPostUserLock DeleteUserPostUserLock EditMePost DeleteMePostComment DeleteMePost EditMeComment NewMePostComment GetMePostVotes NewMePostVote GetMePostCommentsVotes NewMePostCommentVote GetMePostBookmarks NewMePostBookmark DeleteMePostBookmark GetMePostLurks NewMePostLurk DeleteMePostLurk GetMePostLock NewMePostLock DeleteMePostLock NewMeNewPostUserLock DeleteMePostUserLock getProjectPost DeleteProjectPost EditProjectPost getProjectPostComments GetProjectPostComment NewProjectPostComment EditProjectPostComment DeleteProjectPostComment GetProjectPostVotes NewProjectPostVote GetProjectPostCommentsVotes NewProjectPostCommentVote GetProjectPostBookmarks NewProjectPostBookmark DeleteProjectPostBookmark GetProjectPostLurks NewProjectPostLurk DeleteProjectPostLurk GetProjectPostLock NewProjectPostLock DeleteProjectPostLock NewUserNewPostProjectLock DeleteProjectPostUserLock GetMePostComment GetMePostComments GetMePost.
ProjectInfo represents the project information
swagger:response projectInfo.
ProjectsId is a response
swagger:response ProjectsId.
ProjectsIdFollowers is a response
swagger:response ProjectsIdFollowers.
ProjectsIdMembers is a response
swagger:response ProjectsIdMembers.
ProjectsIdPosts is a response
swagger:response ProjectsIdPosts.
ProjectsIdPostsPid is a response
swagger:response ProjectsIdPostsPid.
ProjectsIdPostsPidBookmarks is a response
swagger:response ProjectsIdPostsPidBookmarks.
ProjectsIdPostsPidComments is a response
swagger:response ProjectsIdPostsPidComments.
ProjectsIdPostsPidCommentsCid is a response
swagger:response ProjectsIdPostsPidCommentsCid.
ProjectsIdPostsPidCommentsCidVotes is a response
swagger:response ProjectsIdPostsPidCommentsCidVotes.
ProjectsIdPostsPidLocks is a response
swagger:response ProjectsIdPostsPidLocks.
ProjectsIdPostsPidLurks is a response
swagger:response ProjectsIdPostsPidLurks.
ProjectsIdPostsPidVotes is a response
swagger:response ProjectsIdPostsPidVotes.
Response represents the response format of the API
swagger:response apiResponse.
Target is the ID of the User referenced by the operation
swagger:parameters NewUserNewPostUserLock DeleteUserPostUserLock NewMeNewPostUserLock DeleteMePostUserLock NewMeFollowing DeleteMeFollowing NewProjectFollowing DeleteProjectFollowing NewWhitelisted DeleteWhitelisted NewBlacklisted DeleteBlacklisted NewUserNewPostProjectLock DeleteProjectPostUserLock.
UserInfo represents the user information
swagger:response userInfo.
UsersId is a response
swagger:response UsersId.
UsersIdBlacklist is a response
swagger:response UsersIdBlacklist.
UsersIdBlacklisting is a response
swagger:response UsersIdBlacklisting.
UsersIdFollowers is a response
swagger:response UsersIdFollowers.
UsersIdFollowingProjects is a response
swagger:response UsersIdFollowingProjects.
UsersIdFollowingUsers is a response
swagger:response UsersIdFollowingUsers.
UsersIdFriends is a response
swagger:response UsersIdFriends.
UsersIdPosts is a response
swagger:response UsersIdPosts.
UsersIdPostsPid is a response
swagger:response UsersIdPostsPid.
UsersIdPostsPidBookmarks is a response
swagger:response UsersIdPostsPidBookmarks.
UsersIdPostsPidComments is a response
swagger:response UsersIdPostsPidComments.
UsersIdPostsPidCommentsCid is a response
swagger:response UsersIdPostsPidCommentsCid.
UsersIdPostsPidCommentsCidVotes is a response
swagger:response UsersIdPostsPidCommentsCidVotes.
UsersIdPostsPidLocks is a response
swagger:response UsersIdPostsPidLocks.
UsersIdPostsPidLurks is a response
swagger:response UsersIdPostsPidLurks.
UsersIdPostsPidVotes is a response
swagger:response UsersIdPostsPidVotes.
UsersIdWhitelist is a response
swagger:response UsersIdWhitelist.
UsersIdWhitelisting is a response
swagger:response UsersIdWhitelisting.