Merge pull request #53 from evan-bradley/backend-documentation

Backend documentation

Author: evan-bradley

client/src/components/Browse.vue

@@ -56,7 +56,7 @@
     },
     methods: {
       loadChannels () {
-        this.$http.get(`/api/channels/${this.user.Id}`)
+        this.$http.get(`/api/user/${this.user.Id}/channels`)
           .then(response => {
             if (response.data.success) {
               this.$store.commit('setChannels', response.data.channels)

client/src/components/ChangeEmail.vue

@@ -45,32 +45,16 @@
         if (this.errors.any()) {
           return
         }
-        const passwordVerificationBody = {
-          password: this.password
-        }
         const emailModificationBody = {
-          id: this.user.Id,
-          NewEmail: this.email,
-          currentEmail: this.user.Email,
+          email: this.email,
           password: this.password
         }
-        // TODO: We should combine these two requests into one.
-        this.$http.post('/api/verify/password', passwordVerificationBody)
+
+        this.$http.put(`/api/user/${this.user.Id}/email`, emailModificationBody)
           .then(response => {
-            if (response.data.success) {
-              this.$http.post(`/api/profile/ChangeEmail/${this.user.Id}`, emailModificationBody)
-                .then(response => {
-                  if (response.body.success) {
-                    this.user.Email = emailModificationBody.NewEmail
-                    this.$router.push({name: 'EditProfile'})
-                  } else {
-                    console.log(response)
-                    this.failureMessage = response.data.message
-                  }
-                }, response => {
-                  this.failureMessage = response.data.message
-                  console.log(response)
-                })
+            if (response.body.success) {
+              this.user.Email = emailModificationBody.NewEmail
+              this.$router.push({name: 'EditProfile'})
             } else {
               console.log(response)
               this.failureMessage = response.data.message

client/src/components/Channel.vue

@@ -45,7 +45,7 @@
     methods: {
       loadChannelInformation () {
         var channelId = this.$route.params.channelId
-        this.$http.get(`/api/channel/${channelId}`)
+        this.$http.get(`/api/channels/${channelId}`)
         .then(response => {
           if (response.data.success) {
             this.channel = response.body.channel

client/src/components/Interests.vue

@@ -72,10 +72,10 @@
         if (!this.canSubmitChannels()) return
 
         // Send the channels that the user selected to the server
-        var body = {
+        const body = {
           channels: this.selectedChannels
         }
-        this.$http.post(`/api/channels/${this.user.Id}`, body)
+        this.$http.post(`/api/user/${this.user.Id}/channels`, body)
           .then(response => {
             if (response.data.success) {
               this.$router.push({ name: 'Browse' })

client/src/components/VotingItem.vue

@@ -88,7 +88,7 @@
           console.log('clicked previous')
         },
         next () {
-          this.$http.get(`/api/product?channelId=${this.channel}`)
+          this.$http.get(`/api/product/random?channelId=${this.channel}`)
             .then(response => { // Success
               if (response.data.success) {
                 this.itemName = response.data.product.name.substring(0, 30)

server/package-lock.json

@@ -16,6 +16,7 @@
   "author": "",
   "license": "GPL-3.0",
   "dependencies": {
+    "apidoc": "^0.17.6",
     "bcrypt": "^1.0.3",
     "body-parser": "^1.17.1",
     "chai": "^4.1.2",