Merge pull request #34 from titouanfreville/issue-30-secureAPI

Updated doc
titouanfreville · Mar 10, 2017 · 5b9f1f7 · 5b9f1f7
2 parents 0047b51 + 440dea7
commit 5b9f1f7
Show file tree

Hide file tree

Showing 8 changed files with 892 additions and 67 deletions.
diff --git a/api/api.go b/api/api.go
@@ -185,7 +185,7 @@ func basicRoutes(router *chi.Mux) {
 		r.Route("/newfrominvite", func(r chi.Router) {
 			r.Use(tokenAuth.Verifier)
 			r.Use(allowUserCreationFromToken)
-			// swagger:route POST /publicuser/newfrominvite Users newPublicUser
+			// swagger:route POST /publicuser/newfrominvite Users newInvitedUser
 			//
 			// New user
 			//

diff --git a/api/api_parameters.go b/api/api_parameters.go
@@ -323,11 +323,29 @@ type loginParameterModel struct {
 	Password string `json:"password"`
 }
 
-// swagger:parameters Login
+// swagger:parameters login
 type loginParam struct {
 	// Login informations
 	// in:body
 	Login loginParameterModel `json:"login"`
 }
 
 // <><><><><> <><><><><> <><><><><> <><><><><> //
+// <><><><><> TOKENS PARAMETERS <><><><><> //
+
+// swagger:parameters getAllAvatar getAllAvatar1 newAvatar newAvatar1 getAvatarFromLink getAvatarFromName updateAvatar deleteAvatar getAllChannel getAllChannel1 newChannel newChannel1 getPublicChannel getPrivateChannel getChannelFromType getChannelFromName updateChannel deleteChannel getAllEmoji getAllEmoji1 newEmoji1 newEmoji getEmojiFromLink getEmojiFromName getEmojiFromShortcut updateEmoji deleteEmoji getAllFolder getAllFolder1 newFolder newFolder1 getFolderFromMessage getFolderFromName getFolderFromLink getFolderFromType updateFolder deleteFolder getAllMember getAllMember1 newMember newMember1 getMemberFromChannel getMemberFromUser getMemberFromRole updateMember deleteMember getAllMessage getAllMessage1 newMessage newMessage1 getMessageFromChannel getMessageFromUser getMessageFromDate updateMessage deleteMessage getAllOrganisation getAllOrganisation1 newOrganisation newOrganisation1 updateOrganisation getAllParameter getAllParameter1 newParameter newParameter1 updateParameter getAllRole getAllRole1 newRole newRole1 getRoleFromRights getRoleFromName updateRole deleteRole getAllUser getAllUser1 newUser newUser1 inviteUser getDeletedUser getUserFromRole getOrderedByDate getUserFromName getUserFromNickName getUserFromFirstName getUserFromLastName updateUser deleteUser
+type userTokenParameter struct {
+	// User token you got from login call. Pass it as Authentication: bearer {{token}} in the header
+	// required: true
+	// in:header
+	Token string `json:"token"`
+}
+
+// swagger:parameters newInvitedUser
+type inviteToken struct {
+	// Invite token you got from user/invite call. Pass it as Authentication: bearer {{token}} in the header
+	// in:body
+	Token string `json:"token"`
+}
+
+// <><><><><> <><><><><> <><><><><> <><><><><> //
diff --git a/api/avatar_route.go b/api/avatar_route.go
@@ -114,7 +114,7 @@ func initAvatarRoute(router chi.Router) {
 			// 	  503: databaseError
 			// 	  default: genericError
 			r.Put("/update", updateAvatar)
-			// swagger:route PUT /avatar/{avatarID} Avatars updateAvatar
+			// swagger:route PUT /avatar/{avatarID} Avatars deleteAvatar
 			//
 			// Update avatar
 			//

diff --git a/api/member_route.go b/api/member_route.go
@@ -115,7 +115,7 @@ func initMemberRoute(router chi.Router) {
 			// 	  503: databaseError
 			// 	  default: genericError
 			r.Put("/update", updateMember)
-			// swagger:route PUT /member/{memberID} Members updateMember
+			// swagger:route PUT /member/{memberID} Members deleteMember
 			//
 			// Update member
 			//

diff --git a/api/message_route.go b/api/message_route.go
@@ -120,7 +120,7 @@ func initMessageRoute(router chi.Router) {
 			// 	  503: databaseError
 			// 	  default: genericError
 			r.Put("/update", updateMessage)
-			// swagger:route PUT /message/{messageID} Messages updateMessage
+			// swagger:route PUT /message/{messageID} Messages deleteMessage
 			//
 			// Update message
 			//

diff --git a/api/role_route.go b/api/role_route.go
@@ -31,7 +31,7 @@ func initRoleRoute(router chi.Router) {
 		// 	  503: databaseError
 		// 	  default: genericError
 		r.Get("/", getAllRole)
-		// swagger:route GET /role Roles getAllRole
+		// swagger:route GET /role Roles newRole
 		//
 		// Get roles
 		//

diff --git a/api/user_route.go b/api/user_route.go
@@ -202,7 +202,7 @@ func initUserRoute(router chi.Router) {
 			// 	  503: databaseError
 			// 	  default: genericError
 			r.Put("/update", updateUser)
-			// swagger:route PUT /user/{userID} Users updateUser
+			// swagger:route PUT /user/{userID} Users deleteUser
 			//
 			// Update user
 			//