diff --git a/client/src/components/Admin_UserUpdate/admin_userupdate.js b/client/src/components/Admin_UserUpdate/admin_userupdate.js index cc20189d..3281c2d3 100644 --- a/client/src/components/Admin_UserUpdate/admin_userupdate.js +++ b/client/src/components/Admin_UserUpdate/admin_userupdate.js @@ -1,118 +1,132 @@ -import React,{useEffect,useState} from 'react'; +import React, { useEffect, useState } from "react"; import "./adminScreen.css"; -import {FormControlLabel,Checkbox} from '@material-ui/core'; +import { FormControlLabel, Checkbox } from "@material-ui/core"; import Navbar from "../navbar/Navbar"; -import './adminScreen.css'; -import AOS from 'aos'; -import 'aos/dist/aos.css'; +import "./adminScreen.css"; +import AOS from "aos"; +import "aos/dist/aos.css"; import { toast } from "react-toastify"; import "react-toastify/dist/ReactToastify.css"; toast.configure(); - export default function MultilineTextFields() { - useEffect(()=>{ - AOS.init({ - duration:2000, - delay:1000 - }) -},[]); - - const [setValue] = React.useState('Controlled'); + useEffect(() => { + AOS.init({ + duration: 2000, + delay: 1000 + }); + }, []); -const initialState = { - email: "", - firstName:"", - lastName:"" -}; + const [setValue] = React.useState("Controlled"); -const [formData, setFormData] = useState(initialState); - const [setValue] = React.useState('Controlled'); -// eslint-disable-next-line - const handleChange = (event) => { - setValue(event.target.value); - }; -//TOAST TO DISPLAY FOR INVALID INPUTS WITH CUSTOM MESSAGE PARAMETER -const errorToast = (message) => { - toast.error(message, { - position: "top-center", - autoClose: 3000, - closeOnClick: true, - hideProgressBar: true, - pauseOnHover: true, - draggable: true, - progress: undefined - }); -}; + const initialState = { + email: "", + firstName: "", + lastName: "" + }; -//TOAST TO DISPLAY FOR SUCCESSFULL SIGNIN -const successToast = (message) => { - toast.success(message, { - position: "top-right", - autoClose: 2000, - hideProgressBar: true, - closeOnClick: true, - pauseOnHover: true, - draggable: true, - progress: undefined - }); -}; -const updateUser = (e) => { - //FUNCTION TO DO APPROPRIATE TASK ON CLICKING SUBMIT BUTTON -// eslint-disable-next-line - //CONDITIONS TO CHECK VALID INPUT DETAILS - if (formData.email !== "") { - // eslint-disable-next-line - const valid_email = /^(([^<>()[\]\\.,;:\s@\"]+(\.[^<>()[\]\\.,;:\s@\"]+)*)|(\".+\"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/; - if (valid_email.test(formData.email)) { - if (formData.firstName !== "") { - if(formData.lastName!=""){ - //Code to perform authentication via an api - // if user is successfully signed then then we can have a .then() block - // in which we will show a toast and redirect the user - successToast("Successfully edited"); - } else { - errorToast("Please enter Last Name"); - }} - else { - errorToast("Please enter First Name"); - } - } else { - errorToast("Please enter a valid email id"); - }} - else { - errorToast("Please enter email"); - } -}; - return (


-
-

Edit User

-
-
- - - -
-
- - - -
-
- - - -
- } - label="isAdmin" labelPlacement="isAdmin"/> - - + const [formData, setFormData] = useState(initialState); + //const [setValue] = React.useState("Controlled"); SetValue is already assigned in line 21 + // eslint-disable-next-line + const handleChange = event => { + setValue(event.target.value); + }; + //TOAST TO DISPLAY FOR INVALID INPUTS WITH CUSTOM MESSAGE PARAMETER + const errorToast = message => { + toast.error(message, { + position: "top-center", + autoClose: 3000, + closeOnClick: true, + hideProgressBar: true, + pauseOnHover: true, + draggable: true, + progress: undefined + }); + }; - -
-
- ); -} \ No newline at end of file + //TOAST TO DISPLAY FOR SUCCESSFULL SIGNIN + const successToast = message => { + toast.success(message, { + position: "top-right", + autoClose: 2000, + hideProgressBar: true, + closeOnClick: true, + pauseOnHover: true, + draggable: true, + progress: undefined + }); + }; + const updateUser = e => { + //FUNCTION TO DO APPROPRIATE TASK ON CLICKING SUBMIT BUTTON + // eslint-disable-next-line + //CONDITIONS TO CHECK VALID INPUT DETAILS + if (formData.email !== "") { + // eslint-disable-next-line + const valid_email = /^(([^<>()[\]\\.,;:\s@\"]+(\.[^<>()[\]\\.,;:\s@\"]+)*)|(\".+\"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/; + if (valid_email.test(formData.email)) { + if (formData.firstName !== "") { + if (formData.lastName !== "") { + //Code to perform authentication via an api + // if user is successfully signed then then we can have a .then() block + // in which we will show a toast and redirect the user + successToast("Successfully edited"); + } else { + errorToast("Please enter Last Name"); + } + } else { + errorToast("Please enter First Name"); + } + } else { + errorToast("Please enter a valid email id"); + } + } else { + errorToast("Please enter email"); + } + }; + return ( +
+ +
+
+
+

Edit User

+
+
+ + + +
+
+ + + +
+
+ + + +
+ } + label="isAdmin" + labelPlacement="isAdmin" + /> + + + +
+
+ ); +} diff --git a/client/src/components/UserEditScreen/UserEdit.js b/client/src/components/UserEditScreen/UserEdit.js index 02685d7a..7937f8f9 100644 --- a/client/src/components/UserEditScreen/UserEdit.js +++ b/client/src/components/UserEditScreen/UserEdit.js @@ -1,34 +1,34 @@ import React, { useState, useEffect } from "react"; import { Redirect } from "react-router-dom"; -import { useSelector} from "react-redux"; +import { useSelector } from "react-redux"; import { useMediaQuery } from "react-responsive"; import { toast } from "react-toastify"; import "react-toastify/dist/ReactToastify.css"; import Meta from "../../helpers/Meta"; import usePasswordToggle from "../../hooks/usePasswordToggle"; -import './UserEdit.css'; -import '../SignUp/SignUp.css' +import "./UserEdit.css"; +import "../SignUp/SignUp.css"; import Navbar from "../navbar/Navbar"; -import {Progress} from 'bootstrap-4-react'; -import AOS from 'aos'; -import 'aos/dist/aos.css'; +import { Progress } from "bootstrap-4-react"; +import AOS from "aos"; +import "aos/dist/aos.css"; toast.configure(); const SignUp = () => { - useEffect(()=>{ + useEffect(() => { AOS.init({ - duration:2000, - delay:1000 - }) - },[]); + duration: 2000, + delay: 1000 + }); + }, []); const initialState = { email: "", - firstName:"", - lastName:"" + firstName: "", + lastName: "" }; // eslint-disable-next-line const [PasswordInputType, ToggleIcon] = usePasswordToggle(); - + const getMode = () => { return JSON.parse(localStorage.getItem("mode")) || false; }; @@ -47,20 +47,19 @@ const SignUp = () => { const [lastName, setLastName] = useState(""); const [email, setEmail] = useState(""); const [password, setPassword] = useState(""); - - const auth = useSelector((state) => state.auth); - const user = useSelector((state) => state.user); + const auth = useSelector(state => state.auth); + const user = useSelector(state => state.user); const [formData, setFormData] = useState(initialState); //MAKING CHANGE IN STATE VALUES FROM USER INPUT // eslint-disable-next-line - const handleChange = (e) => { + const handleChange = e => { setFormData({ ...formData, [e.target.name]: e.target.value }); }; //TOAST TO DISPLAY FOR INVALID INPUTS WITH CUSTOM MESSAGE PARAMETER - const errorToast = (message) => { + const errorToast = message => { toast.error(message, { position: "top-center", autoClose: 3000, @@ -73,7 +72,7 @@ const SignUp = () => { }; //TOAST TO DISPLAY FOR SUCCESSFULL SIGNIN - const successToast = (message) => { + const successToast = message => { toast.success(message, { position: "top-right", autoClose: 2000, @@ -85,30 +84,30 @@ const SignUp = () => { }); }; - const editUser = (e) => { + const editUser = e => { //FUNCTION TO DO APPROPRIATE TASK ON CLICKING SUBMIT BUTTON - // eslint-disable-next-line + // eslint-disable-next-line //CONDITIONS TO CHECK VALID INPUT DETAILS if (formData.email !== "") { // eslint-disable-next-line const valid_email = /^(([^<>()[\]\\.,;:\s@\"]+(\.[^<>()[\]\\.,;:\s@\"]+)*)|(\".+\"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/; if (valid_email.test(formData.email)) { if (formData.firstName !== "") { - if(formData.lastName!=""){ - //Code to perform authentication via an api - // if user is successfully signed then then we can have a .then() block - // in which we will show a toast and redirect the user - successToast("Successfully edited"); + if (formData.lastName !== "") { + //Code to perform authentication via an api + // if user is successfully signed then then we can have a .then() block + // in which we will show a toast and redirect the user + successToast("Successfully edited"); + } else { + errorToast("Please enter Last Name"); + } } else { - errorToast("Please enter Last Name"); - }} - else { errorToast("Please enter First Name"); } } else { errorToast("Please enter a valid email id"); - }} - else { + } + } else { errorToast("Please enter email"); } }; @@ -117,65 +116,99 @@ const SignUp = () => { } if (user.loading) { - return Loading....; + return ( + + + Loading.... + + + ); } return ( -
- - -
- img -
-
-

Update Profile

-
- - setFirstName(e.target.value) - } - required/> -
-
- - setLastName(e.target.value) - } - required /> -
-
- setEmail(e.target.value)} - required/> -
-
- - setPassword(e.target.value) - } - required /> -
-
- -
-
-
preview -
- +
+ + +
+ img +
+
+

Update Profile

+
+ setFirstName(e.target.value)} + required + /> +
+
+ setLastName(e.target.value)} + required + /> +
+
+ setEmail(e.target.value)} + required + /> +
+
+ setPassword(e.target.value)} + required + /> +
+
+ +
+
+
+ preview +
+
); - } +}; export default SignUp; diff --git a/client/src/store/index.js b/client/src/store/index.js index b75609f6..cadeeed8 100644 --- a/client/src/store/index.js +++ b/client/src/store/index.js @@ -1,41 +1,51 @@ -import thunk from 'redux-thunk'; -import { applyMiddleware, createStore,combineReducers } from 'redux'; -import { composeWithDevTools } from 'redux-devtools-extension' - -import {userListReducer, userUpdateReducer, userUpdateProfileReducer} from '../reducers/user.reducers' -import { answerListReducer, userUpdateAnswerReducer } from "../reducers/answer.reducer"; - - - -import {questionListReducer, userUpdateQuestionReducer} from '../reducers/question.reducer' - -import {commentListReducer, userUpdateCommentReducer} from '../reducers/comment.reducer' - -import {userDownvoteReducer} from '../reducers/downvote.reducer' - -import {userUpvoteReducer} from '../reducers/upvote.reducer' - +import thunk from "redux-thunk"; +import { applyMiddleware, createStore, combineReducers } from "redux"; +import { composeWithDevTools } from "redux-devtools-extension"; + +import { + userListReducer, + userUpdateReducer, + userUpdateProfileReducer +} from "../reducers/user.reducers"; +import { + answerListReducer, + userUpdateAnswerReducer +} from "../reducers/answer.reducer"; + +import { + questionListReducer, + userUpdateQuestionReducer +} from "../reducers/question.reducer"; + +import { + commentListReducer, + userUpdateCommentReducer +} from "../reducers/comment.reducer"; + +import { userDownvoteReducer } from "../reducers/downvote.reducer"; + +import { userUpvoteReducer } from "../reducers/upvote.reducer"; const reducer = combineReducers({ - userList: userListReducer, - userUpdate: userUpdateReducer, - userUpdateProfile: userUpdateProfileReducer, - commentListr: commentListReducer, - questionList:questionListReducer, - answerList: answerListReducer, - userUpdateQuestion:userUpdateQuestionReducer, - userUpdateComment: userUpdateCommentReducer, - userUpdateAnswer: userUpdateAnswerReducer, - - userDownvote:userDownvoteReducer - - userUpvote:userUpvoteReducer, - - -}) - -const middleware = [thunk] -const store = createStore( reducer, - composeWithDevTools(applyMiddleware(...middleware))); - -export default store; + userList: userListReducer, + userUpdate: userUpdateReducer, + userUpdateProfile: userUpdateProfileReducer, + commentListr: commentListReducer, + questionList: questionListReducer, + answerList: answerListReducer, + userUpdateQuestion: userUpdateQuestionReducer, + userUpdateComment: userUpdateCommentReducer, + userUpdateAnswer: userUpdateAnswerReducer, + + userDownvote: userDownvoteReducer, + + userUpvote: userUpvoteReducer +}); + +const middleware = [thunk]; +const store = createStore( + reducer, + composeWithDevTools(applyMiddleware(...middleware)) +); + +export default store; diff --git a/server/API DOCS/GET.md b/server/API DOCS/GET.md index 846095f7..d2938643 100644 --- a/server/API DOCS/GET.md +++ b/server/API DOCS/GET.md @@ -1,755 +1,825 @@ # GET API DOCS + **1. Get All Questions** -* **URL** + +- **URL** `/api/allQuestions` -* **METHOD** +- **METHOD** `GET` `**NOTE**: in the headers you have to authorize token and you can get token by signin API ` +- **Success Response**
-* **Success Response**
- * **Code:** `201`
- **data:** `{ questions: [ displaying all question data] }` + - **Code:** `201`
+ **data:** `{ questions: [ displaying all question data] }` -* **Error Response** - * **Code:** `401`
- **Message:** `authorization required`
+- **Error Response** -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** + - **Code:** `401`
+ **Message:** `authorization required`
+- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **2. Get answers** -* **URL** + +- **URL** `/api/getAnswers/:id` -* **METHOD** +- **METHOD** `GET` -* **Success Response**
- * **Code:** `200`
- **data:** `{ answers: [ displaying all answers to a particular question] }` +- **Success Response**
-* **Error Response** - * **Code:** `400`
- **Message:** `something went wrong`
+ - **Code:** `200`
+ **data:** `{ answers: [ displaying all answers to a particular question] }` -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +- **Error Response** + + - **Code:** `400`
+ **Message:** `something went wrong`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **3. Get specific questions** -* **URL** + +- **URL** `/api/searchQuestions` -* **METHOD** +- **METHOD** `GET` -* **Success Response**
- * **Code:** `200`
- **data:** `{ questions: [ displaying all questions related to the search] }` +- **Success Response**
-* **Error Response** - * **Code:** `400`
- **Message:** `something went wrong`
+ - **Code:** `200`
+ **data:** `{ questions: [ displaying all questions related to the search] }` -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +- **Error Response** + + - **Code:** `400`
+ **Message:** `something went wrong`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **4. Get All Spaces** -* **URL** + +- **URL** `/api/getSpaces` -* **METHOD** +- **METHOD** `GET` `**NOTE**: in the headers you have to authorize token and you can get token by signin API ` +- **Success Response**
-* **Success Response**
- * **Code:** `201`
- **data:** `{ Spaces: [ displaying all available spaces] }` + - **Code:** `201`
+ **data:** `{ Spaces: [ displaying all available spaces] }` -* **Error Response** - * **Code:** `401`
- **Message:** `authorization required`
+- **Error Response** -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** + - **Code:** `401`
+ **Message:** `authorization required`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **5. Get All Spaces** -* **URL** + +- **URL** `/api/getSpacebyId` -* **METHOD** +- **METHOD** `GET` `**NOTE**: in the headers you have to authorize token and you can get token by signin API ` +- **Success Response**
-* **Success Response**
- * **Code:** `200`
- **data:** `{ Spaces: [ displaying all spaces created by the specific user] }` + - **Code:** `200`
+ **data:** `{ Spaces: [ displaying all spaces created by the specific user] }` -* **Error Response** - * **Code:** `400`
- **Message:** `authorization required`
+- **Error Response** -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** + - **Code:** `400`
+ **Message:** `authorization required`
+- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **6.ADMIN: Get All users** -* **URL** + +- **URL** `/api/admin/users` -* **METHOD** +- **METHOD** `GET` -* **Success Response**
- * **Code:** `200`
- **data:** `{ users:[array of all the users] }` +- **Success Response**
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : True** + - **Code:** `200`
+ **data:** `{ users:[array of all the users] }` +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : True** **7.ADMIN: Get All questions** -* **URL** + +- **URL** `/api/admin/questions` -* **METHOD** +- **METHOD** `GET` -* **Success Response**
- * **Code:** `200`
- **data:** `{ questions:[array of all the questions] }` +- **Success Response**
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : True** + - **Code:** `200`
+ **data:** `{ questions:[array of all the questions] }` +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : True** **8.ADMIN: Get All answers** -* **URL** + +- **URL** `/api/admin/answers` -* **METHOD** +- **METHOD** `GET` -* **Success Response**
- * **Code:** `200`
- **data:** `{ answers:[array of all the answers] }` - -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : True** +- **Success Response**
+ - **Code:** `200`
+ **data:** `{ answers:[array of all the answers] }` +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : True** **6. ADMIN: Get user by Id** -* **URL** + +- **URL** `/api/admin/user/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `id` -* **Success Response**
- * **Code:** `200`
- **data:** `{user}`
+- **Success Response**
+ + - **Code:** `200`
+ **data:** `{user}`
-* **Error Response** - * **Code:** `404`
- **Message:** `User not found`
+- **Error Response** -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : True** + - **Code:** `404`
+ **Message:** `User not found`
+- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : True** **7. ADMIN: Get question by Id** -* **URL** + +- **URL** `/api/admin/question/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `id` -* **Success Response**
- * **Code:** `200`
- **data:** `{question}`
+- **Success Response**
-* **Error Response** - * **Code:** `404`
- **Message:** `Question not found`
+ - **Code:** `200`
+ **data:** `{question}`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : True** +- **Error Response** + - **Code:** `404`
+ **Message:** `Question not found`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : True** **8. ADMIN: Get answer by Id** -* **URL** + +- **URL** `/api/admin/answer/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `id` -* **Success Response**
- * **Code:** `200`
- **data:** `{answer}`
+- **Success Response**
+ + - **Code:** `200`
+ **data:** `{answer}`
-* **Error Response** - * **Code:** `404`
- **Message:** `Answer not found`
+- **Error Response** -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : True** + - **Code:** `404`
+ **Message:** `Answer not found`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : True** **9. upvote answer** -* **URL** + +- **URL** `/api/upvote/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `particular answer id` -* **Success Response**
- * **Code:** `200`
- **data:** `{message: "upvoted!"}` +- **Success Response**
-* **Error Response** - * **Code:** `400`
- **Message:** `something went wrong`
- - * **Code:** `400`
- **Message:** `you can not upvote answer that was created by you`
+ - **Code:** `200`
+ **data:** `{message: "upvoted!"}` -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +- **Error Response** + + - **Code:** `400`
+ **Message:** `something went wrong`
+ + - **Code:** `400`
+ **Message:** `you can not upvote answer that was created by you`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **10. downvote answer** -* **URL** + +- **URL** `/api/downvote/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `particular answer id` -* **Success Response**
- * **Code:** `200`
- **data:** `{message: "downvoted!"}` +- **Success Response**
+ + - **Code:** `200`
+ **data:** `{message: "downvoted!"}` + +- **Error Response** -* **Error Response** - * **Code:** `400`
- **Message:** `something went wrong`
- - * **Code:** `400`
- **Message:** `you can not downvote answer that was created by you`
+ - **Code:** `400`
+ **Message:** `something went wrong`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** + - **Code:** `400`
+ **Message:** `you can not downvote answer that was created by you`
-**11. get upvoted answers** -* **URL** +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** + +**11. get upvoted answers** + +- **URL** `/api/getUpvotedAnswers` -* **METHOD** +- **METHOD** `GET` -* **Success Response**
- * **Code:** `200`
- **data:** `{upvotedAnswers: [array of answers upvoted by the user]}` +- **Success Response**
+ + - **Code:** `200`
+ **data:** `{upvotedAnswers: [array of answers upvoted by the user]}` -* **Error Response** - * **Code:** `400`
- **Message:** `something went wrong`
+- **Error Response** -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** + - **Code:** `400`
+ **Message:** `something went wrong`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **12. search answers** -* **URL** + +- **URL** `/api/searchAnswers` -* **METHOD** +- **METHOD** `GET` -* **query params (optional)** +- **query params (optional)** `createdBy`, `tags`, `questionId` -* **Success Response**
- * **Code:** `200`
- **data:** `{answers: [array of answers with filter applied as per the query string]}` +- **Success Response**
-* **Error Response** - * **Code:** `400`
- **Message:** `something went wrong`
+ - **Code:** `200`
+ **data:** `{answers: [array of answers with filter applied as per the query string]}` -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +- **Error Response** -**13. get comment by Id** -* **URL** + - **Code:** `400`
+ **Message:** `something went wrong`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** + +**13. get comment by Id** + +- **URL** `/api/getCommentById/:id` -* **METHOD** +- **METHOD** `GET` -* **Success Response**
- * **Code:** `200`
- **Message:** `comment found!` - **data:** `{comment}` +- **Success Response**
+ + - **Code:** `200`
+ **Message:** `comment found!` + **data:** `{comment}` + +- **Error Response** + + - **Code:** `400`
+ **Message:** `invalid comment id`
-* **Error Response** - * **Code:** `400`
- **Message:** `invalid comment id`
+ - **Code:** `400`
+ **Message:** `comment does not exist!`
- * **Code:** `400`
- **Message:** `comment does not exist!`
+ - **Code:** `400`
+ **Message:** `something went wrong!`
- * **Code:** `400`
- **Message:** `something went wrong!`
+- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +**14. get my comments** -**14. get my comments** -* **URL** +- **URL** `/api/getMyComments` -* **METHOD** +- **METHOD** `GET` -* **Success Response**
- * **Code:** `200`
- **Message:** `comments found!` - **data:** `{comments: [array of comments]}` +- **Success Response**
-* **Error Response** - * **Code:** `400`
- **Message:** `you have not commented on any answer!`
- * **Code:** `400`
- **Message:** `something went wrong!`
+ - **Code:** `200`
+ **Message:** `comments found!` + **data:** `{comments: [array of comments]}` -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +- **Error Response** -**15. get comments for answer** -* **URL** + - **Code:** `400`
+ **Message:** `you have not commented on any answer!`
+ - **Code:** `400`
+ **Message:** `something went wrong!`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** + +**15. get comments for answer** + +- **URL** `/api/getCommentsForAnswer/:id` -* **METHOD** +- **METHOD** `GET` -* **Success Response**
- * **Code:** `200`
- **Message:** `comments found!` - **data:** `{comments: [array of comments]}` +- **Success Response**
+ + - **Code:** `200`
+ **Message:** `comments found!` + **data:** `{comments: [array of comments]}` + +- **Error Response** -* **Error Response** - * **Code:** `400`
- **Message:** `invalid answer id`
+ - **Code:** `400`
+ **Message:** `invalid answer id`
- * **Code:** `400`
- **Message:** `invalid answer id, no such answer exists in the database!`
- - * **Code:** `400`
- **Message:** `no comments for this particular answer yet!`
+ - **Code:** `400`
+ **Message:** `invalid answer id, no such answer exists in the database!`
- * **Code:** `400`
- **Message:** `something went wrong`
+ - **Code:** `400`
+ **Message:** `no comments for this particular answer yet!`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** + - **Code:** `400`
+ **Message:** `something went wrong`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **16. upvote question** -* **URL** + +- **URL** `/upvoteQuestion/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `particular question id` -* **Success Response**
- * **Code:** `200`
- **data:** `{message: "question upvoted!!"}` - - * **Code:** `200`
- **data:** `{message: "already upvoted!!"}` - -* **Error Response** - * **Code:** `400`
- **Message:** `something went wrong`
- - * **Code:** `400`
- **Message:** `you can not upvote question that was created by you`
- -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** - -**17. downvote question** -* **URL** +- **Success Response**
+ + - **Code:** `200`
+ **data:** `{message: "question upvoted!!"}` + + - **Code:** `200`
+ **data:** `{message: "already upvoted!!"}` + +- **Error Response** + + - **Code:** `400`
+ **Message:** `something went wrong`
+ + - **Code:** `400`
+ **Message:** `you can not upvote question that was created by you`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** + +**17. downvote question** + +- **URL** `/upvoteQuestion/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `particular question id` -* **Success Response**
- * **Code:** `200`
- **data:** `{message: "downvoted!"}` +- **Success Response**
+ + - **Code:** `200`
+ **data:** `{message: "downvoted!"}` + + - **Code:** `200`
+ **data:** `{message: "already downvoted!"}` - * **Code:** `200`
- **data:** `{message: "already downvoted!"}` +- **Error Response** -* **Error Response** - * **Code:** `400`
- **Message:** `something went wrong`
+ - **Code:** `400`
+ **Message:** `something went wrong`
- * **Code:** `400`
- **Message:** `you can not downvote question that was created by you`
+ - **Code:** `400`
+ **Message:** `you can not downvote question that was created by you`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** -**18. get upvoted questions** -* **URL** +**18. get upvoted questions** + +- **URL** `/api/getUpvotedAnswers` -* **METHOD** +- **METHOD** `GET` -* **Success Response**
- * **Code:** `200`
- **data:** `{upvotedAnswers: [array of questions upvoted by the user]}` +- **Success Response**
+ + - **Code:** `200`
+ **data:** `{upvotedAnswers: [array of questions upvoted by the user]}` + +- **Error Response** -* **Error Response** + - **Code:** `400`
+ **Message:** `you haven't upvoted any question!`
- * **Code:** `400`
- **Message:** `you haven't upvoted any question!`
+ - **Code:** `400`
+ **Message:** `something went wrong!`
- * **Code:** `400`
- **Message:** `something went wrong!`
+- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +**19. get upvoted question** -**19. get upvoted question** -* **URL** +- **URL** `/getUpvotedQuestion/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `question id` -* **Success Response**
- * **Code:** `200`
- **data:** `{upvotedQuestion}` +- **Success Response**
+ + - **Code:** `200`
+ **data:** `{upvotedQuestion}` + +- **Error Response** + + - **Code:** `400`
+ **Message:** `invalid question id!`
-* **Error Response** + - **Code:** `400`
+ **Message:** `no upvoted question with entered id exists!`
- * **Code:** `400`
- **Message:** `invalid question id!`
- - * **Code:** `400`
- **Message:** `no upvoted question with entered id exists!`
- - * **Code:** `400`
- **Message:** `something went wrong`
+ - **Code:** `400`
+ **Message:** `something went wrong`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** -**20. get upvoted answer** -* **URL** +**20. get upvoted answer** + +- **URL** `/getUpvotedAnswer/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `answer id` -* **Success Response**
- * **Code:** `200`
- **data:** `{upvotedAnswer}` +- **Success Response**
+ + - **Code:** `200`
+ **data:** `{upvotedAnswer}` + +- **Error Response** -* **Error Response** + - **Code:** `400`
+ **Message:** `invalid answer id!`
- * **Code:** `400`
- **Message:** `invalid answer id!`
- - * **Code:** `400`
- **Message:** `no upvoted answer with entered id exists!`
- - * **Code:** `400`
- **Message:** `something went wrong`
+ - **Code:** `400`
+ **Message:** `no upvoted answer with entered id exists!`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** + - **Code:** `400`
+ **Message:** `something went wrong`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **21. get answer stats** -* **URL** + +- **URL** `/api/getAnswerStats/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `particular answer id` -* **Success Response**
- * **Code:** `200`
- **Message:** `answer statistics!` - **data:** `{statistics: {"views": answer.views, "upvotes": answer.upvotes, "downvotes": answer.downvotes}}` +- **Success Response**
-* **Error Response** + - **Code:** `200`
+ **Message:** `answer statistics!` + **data:** `{statistics: {"views": answer.views, "upvotes": answer.upvotes, "downvotes": answer.downvotes}}` - * **Code:** `400`
- **Message:** `answer does not exist!`
- - * **Code:** `400`
- **Message:** `invalid answer id!`
+- **Error Response** - * **Code:** `400`
- **Message:** `something went wrong!`
+ - **Code:** `400`
+ **Message:** `answer does not exist!`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** + - **Code:** `400`
+ **Message:** `invalid answer id!`
+ + - **Code:** `400`
+ **Message:** `something went wrong!`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **22. get question stats** -* **URL** + +- **URL** `/api/getQuestionStats/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `particular question id` -* **Success Response**
- * **Code:** `200`
- **Message:** `quetsion statistics!` - **data:** `{statistics: {"views": question.views, "upvotes": question.upvotes, "downvotes": question.downvotes, "answerCount": answerCount}}` +- **Success Response**
-* **Error Response** + - **Code:** `200`
+ **Message:** `question statistics!` + **data:** `{statistics: {"views": question.views, "upvotes": question.upvotes, "downvotes": question.downvotes, "answerCount": answerCount}}` - * **Code:** `400`
- **Message:** `question does not exist!`
- - * **Code:** `400`
- **Message:** `invalid question id!`
+- **Error Response** - * **Code:** `400`
- **Message:** `something went wrong!`
+ - **Code:** `400`
+ **Message:** `question does not exist!`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** + - **Code:** `400`
+ **Message:** `invalid question id!`
+ + - **Code:** `400`
+ **Message:** `something went wrong!`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **23. get notifications** -* **URL** + +- **URL** `/api/getNotifications` -* **METHOD** +- **METHOD** `GET` -* **Success Response**
- * **Code:** `200`
- **Message:** `unread notifications!` - **data:** `{notifications}` +- **Success Response**
-* **Success Response**
- * **Code:** `200`
- **Message:** `no new notifications!` + - **Code:** `200`
+ **Message:** `unread notifications!` + **data:** `{notifications}` -* **Error Response** +- **Success Response**
- * **Code:** `400`
- **Message:** `something went wrong!`
+ - **Code:** `200`
+ **Message:** `no new notifications!` -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +- **Error Response** + - **Code:** `400`
+ **Message:** `something went wrong!`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **24. get notification by id** -* **URL** + +- **URL** `/api/getNotification/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `particular notification id` -* **Success Response**
- * **Code:** `200`
- **Message:** `notification` - **data:** `{notification}` +- **Success Response**
+ + - **Code:** `200`
+ **Message:** `notification` + **data:** `{notification}` -* **Error Response** +- **Error Response** - * **Code:** `400`
- **Message:** `invalid notification id!`
- - * **Code:** `400`
- **Message:** `notification does not exist!`
+ - **Code:** `400`
+ **Message:** `invalid notification id!`
- * **Code:** `400`
- **Message:** `notification not intended to you!`
+ - **Code:** `400`
+ **Message:** `notification does not exist!`
- * **Code:** `400`
- **Message:** `something went wrong!`
+ - **Code:** `400`
+ **Message:** `notification not intended to you!`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** + - **Code:** `400`
+ **Message:** `something went wrong!`
+- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **25. upvote comment** -* **URL** + +- **URL** `/api/upvoteComment/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `particular comment id` -* **Success Response**
- * **Code:** `200`
- **data:** `{message: "upvoted!"}` +- **Success Response**
+ + - **Code:** `200`
+ **data:** `{message: "upvoted!"}` -* **Error Response** - * **Code:** `400`
- **Message:** `something went wrong`
- - * **Code:** `400`
- **Message:** `you can not upvote comment that was created by you`
+- **Error Response** -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** + - **Code:** `400`
+ **Message:** `something went wrong`
+ + - **Code:** `400`
+ **Message:** `you can not upvote comment that was created by you`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **26. downvote comment** -* **URL** + +- **URL** `/api/downvoteComment/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `particular comment id` -* **Success Response**
- * **Code:** `200`
- **data:** `{message: "downvoted!"}` +- **Success Response**
+ + - **Code:** `200`
+ **data:** `{message: "downvoted!"}` + +- **Error Response** + + - **Code:** `400`
+ **Message:** `something went wrong`
-* **Error Response** - * **Code:** `400`
- **Message:** `something went wrong`
- - * **Code:** `400`
- **Message:** `you can not downvote comment that was created by you`
+ - **Code:** `400`
+ **Message:** `you can not downvote comment that was created by you`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **27. get questions of users who you follow** -* **URL** + +- **URL** `/getQuestionsOfFollowing` -* **METHOD** +- **METHOD** `GET` +- **Success Response**
+ + - **Code:** `200`
+ **data:** `questions_list array` + +- **Error Response** -* **Success Response**
- * **Code:** `200`
- **data:** `questions_list array` + - **Code:** `400`
+ **Message:** `something went wrong`
-* **Error Response** - * **Code:** `400`
- **Message:** `something went wrong`
- - * **Code:** `400`
- **Message:** `you don't follow anyone!`
+ - **Code:** `400`
+ **Message:** `you don't follow anyone!`
- * **Code:** `400`
- **Message:** `no questions!`
+ - **Code:** `400`
+ **Message:** `no questions!`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** -**28. view user by id** -* **URL** +**28. view user by id** + +- **URL** `/viewUserById/:id` -* **METHOD** +- **METHOD** `GET` -* **URL params** +- **URL params** `particular user id` -* **Success Response**
- * **Code:** `200`
- **data:** `user profile` +- **Success Response**
+ + - **Code:** `200`
+ **data:** `user profile` +- **Error Response** -* **Error Response** - * **Code:** `400`
- **Message:** `something went wrong!`
+ - **Code:** `400`
+ **Message:** `something went wrong!`
- * **Code:** `400`
- **Message:** `invalid id!`
+ - **Code:** `400`
+ **Message:** `invalid id!`
- * **Code:** `400`
- **Message:** `user does not exist!`
+ - **Code:** `400`
+ **Message:** `user does not exist!`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** diff --git a/server/API DOCS/POST.md b/server/API DOCS/POST.md index da9d538e..5273fc30 100644 --- a/server/API DOCS/POST.md +++ b/server/API DOCS/POST.md @@ -1,260 +1,290 @@ # POST API DOCS + **1. Signup for the admin or the user** -* **URL** + +- **URL** `/api/admin/signup` - or + or `/api/signup` -* **METHOD** +- **METHOD** `POST` -* **PASSED OBJETCS**
+- **PASSED OBJETCS**
`firstName [required],`
`lastName [required],`
` password [required],`
- ` confirmPassword [required],`
+ ` confirmPassword [required],`
` email [required],`
` userName,`
` year,`
` collegeName,`
` contactNumber` -* **Success Response**
- * **Code:** `201`
- **Message:** `User Created Succesfully...!`
- **data:** `{ token: "token generetaed" }` +- **Success Response**
+ + - **Code:** `201`
+ **Message:** `User Created Succesfully...!`
+ **data:** `{ token: "token generated" }` -* **Error Response** - * **Code:** `400`
- **Message:** `User is already registered`
+- **Error Response** -* **Required Filed** - * **Auth Need : False** - * **Admin Auth Need : False** + - **Code:** `400`
+ **Message:** `User is already registered`
+ +- **Required Filed** + - **Auth Need : False** + - **Admin Auth Need : False** **2. Signin for the admin or the user** -* **URL** + +- **URL** `/api/admin/signin` - or + or `/api/signin` -* **METHOD** +- **METHOD** `POST` -* **PASSED OBJETCS**
+- **PASSED OBJETCS**
` email [required],`
` password [required]`
-* **Success Response**
- * **Code:** `200`
- **Message:** ` User Logged in`
- **data:** `{ token: "token generetaed", user: "user_info" }` +- **Success Response**
-* **Error Response** - * **Code:** `401`
- **Message:** `Invalid password or valid email is required`
+ - **Code:** `200`
+ **Message:** ` User Logged in`
+ **data:** `{ token: "token generated", user: "user_info" }` -* **Required Filed** - * **Auth Need : False** - * **Admin Auth Need : False** +- **Error Response** + + - **Code:** `401`
+ **Message:** `Invalid password or valid email is required`
+ +- **Required Filed** + - **Auth Need : False** + - **Admin Auth Need : False** **3. Signout for the admin or the user** -* **URL** + +- **URL** `/api/admin/signout` - or + or `/api/signout` -* **METHOD** +- **METHOD** `POST` `**NOTE**: in the headers you have to authorize token and you can get token by signin API ` -* **Success Response**
- * **Code:** `200`
- **Message:** `Signout Successful`
- **data:** `null` +- **Success Response**
+ + - **Code:** `200`
+ **Message:** `Signout Successful`
+ **data:** `null` -* **Error Response** - * **Code:** `401`
- **Message:** `Authorization Required`
+- **Error Response** -* **Required Filed** - * **Auth/ Admin Auth: true/true** + - **Code:** `401`
+ **Message:** `Authorization Required`
+ +- **Required Filed** + - **Auth/ Admin Auth: true/true** **4. Add questions** -* **URL** + +- **URL** `/api/question` -* **METHOD** +- **METHOD** `POST` -* **PASSED OBJETCS**
+- **PASSED OBJETCS**
` questionText [required],`
` tags [required],`
- ` questionLinks,`
+ ` questionLinks,`
`**NOTE**: in the headers you have to authorize token and you can get token by signin API ` -* **Success Response**
- * **Code:** `200`
- **Message:** `Question added successfully`
- **data:** `{ _id_: "questionID", questionText: "question_text", tags: "tags", createdBy: "user_id" }` +- **Success Response**
+ + - **Code:** `200`
+ **Message:** `Question added successfully`
+ **data:** `{ _id_: "questionID", questionText: "question_text", tags: "tags", createdBy: "user_id" }` + +- **Error Response** + + - **Code:** `400`
+ **Message:** `Question not created ! Something went wrong! or Authorization Required`
-* **Error Response** - * **Code:** `400`
- **Message:** `Question not created ! Something went wrong! or Authorization Required`
+- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +**5. Add answers** -**5. Add answers** -* **URL** +- **URL** `/api/question/answers` -* **METHOD** +- **METHOD** `POST` `**NOTE**: in the headers you have to authorize token and you can get token by signin API ` -* **Success Response**
- * **Code:** `200`
- **Message:** `Answer added successfully`
- **data:** `{ tags: [tags], _id: "answerID", answerText: "answer_text", questionId: "questionID", createdBy: "user_id" }` - -* **Error Response** - * **Code:** `400`
- **Message:** `Something went wrong or Authorization required`
- - * **Code:** `400`
- **Message:** `you can not answer a question that was created by you!`
- - * **Code:** `400`
- **Message:** `Please fill the required field`
- - * **Code:** `400`
- **Message:** `you have already answered that question! wish to edit that?`
- - * **Code:** `400`
- **Message:** `invalid questionId!`
- -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +- **Success Response**
+ + - **Code:** `200`
+ **Message:** `Answer added successfully`
+ **data:** `{ tags: [tags], _id: "answerID", answerText: "answer_text", questionId: "questionID", createdBy: "user_id" }` + +- **Error Response** + + - **Code:** `400`
+ **Message:** `Something went wrong or Authorization required`
+ + - **Code:** `400`
+ **Message:** `you can not answer a question that was created by you!`
+ + - **Code:** `400`
+ **Message:** `Please fill the required field`
+ + - **Code:** `400`
+ **Message:** `you have already answered that question! wish to edit that?`
+ + - **Code:** `400`
+ **Message:** `invalid questionId!`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **6. Create Spaces** -* **URL** + +- **URL** `/api/createSpace` -* **METHOD** +- **METHOD** `POST` `**NOTE**: in the headers you have to authorize token and you can get token by signin API ` -* **Success Response**
- * **Code:** `200`
- **Message:** `Space created successfully`
- **data:** `{ role: [role], _id: "spaceID", spaceName: "space_name", description: "description", createdBy: "user_id" }` +- **Success Response**
-* **Error Response** - * **Code:** `400`
- **Message:** `Authorization required`
+ - **Code:** `200`
+ **Message:** `Space created successfully`
+ **data:** `{ role: [role], _id: "spaceID", spaceName: "space_name", description: "description", createdBy: "user_id" }` -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : True** +- **Error Response** + - **Code:** `400`
+ **Message:** `Authorization required`
-**7. Post Commment** -* **URL** +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : True** + +**7. Post Comment** + +- **URL** `/api/postComment` -* **METHOD** +- **METHOD** `POST` `**NOTE**: in the headers you have to authorize token and you can get token by signin API ` -* **Success Response**
- * **Code:** `200`
- **Message:** `comment saved!`
- **data:** `{ comment:[answerId,text, updatedAt, created_by: user.firstName + user.lastName ] }` +- **Success Response**
+ + - **Code:** `200`
+ **Message:** `comment saved!`
+ **data:** `{ comment:[answerId,text, updatedAt, created_by: user.firstName + user.lastName ] }` + +- **Error Response** -* **Error Response** - * **Code:** `400`
- **Message:** `something went wrong!`
+ - **Code:** `400`
+ **Message:** `something went wrong!`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **8. BookMark Question** -* **URL** + +- **URL** `/api/bookmarkQues` -* **METHOD** +- **METHOD** `POST` `**NOTE**: in the headers you have to authorize token and you can get token by signin API ` -* **Success Response**
- * **Code:** `200`
- **Message:** `bookmarked your question!`
- **data:** `{ question }` +- **Success Response**
+ + - **Code:** `200`
+ **Message:** `bookmarked your question!`
+ **data:** `{ question }` + +- **Error Response** -* **Error Response** - * **Code:** `400`
- **Message:** `Question not found`
+ - **Code:** `400`
+ **Message:** `Question not found`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **9. allBookMark Question** -* **URL** + +- **URL** `/api/allBookmarkQues` -* **METHOD** +- **METHOD** `POST` `**NOTE**: in the headers you have to authorize token and you can get token by signin API ` -* **Success Response**
- * **Code:** `200`
- **Message:** `Your list`
- **data:** `{ questions_list }` +- **Success Response**
+ + - **Code:** `200`
+ **Message:** `Your list`
+ **data:** `{ questions_list }` -* **Error Response** - * **Code:** `400`
- **Message:** `Something went wrong`
+- **Error Response** -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** + - **Code:** `400`
+ **Message:** `Something went wrong`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** **9. view user profiles by name** -* **URL** + +- **URL** `/api/viewUsersByName` -* **METHOD** +- **METHOD** `POST` `**NOTE**: in the headers you have to authorize token and you can get token by signin API ` -* **Success Response**
- * **Code:** `200`
- **Message:** `relevant user profiles`
- **data:** `users array` +- **Success Response**
+ + - **Code:** `200`
+ **Message:** `relevant user profiles`
+ **data:** `users array` + +- **Error Response** -* **Error Response** - * **Code:** `400`
- **Message:** `please enter required fields`
+ - **Code:** `400`
+ **Message:** `please enter required fields`
- * **Code:** `400`
- **Message:** `user does not exist!`
+ - **Code:** `400`
+ **Message:** `user does not exist!`
- * **Code:** `400`
- **Message:** `something went wrong`
+ - **Code:** `400`
+ **Message:** `something went wrong`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : False** \ No newline at end of file +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : False** diff --git a/server/API DOCS/PUT.md b/server/API DOCS/PUT.md index d23644c7..283ede32 100644 --- a/server/API DOCS/PUT.md +++ b/server/API DOCS/PUT.md @@ -1,12 +1,14 @@ # PUT API DOCS -**1.ADIMN: Update User Profile** -* **URL** + +**1.ADMIN: Update User Profile** + +- **URL** `/apiadmin/user/:id` -* **METHOD** +- **METHOD** `PUT` -* **PASSED OBJETCS**
+- **PASSED OBJECTS**
required atleast one field to update @@ -15,108 +17,121 @@ ` email,`
`isAdmin,` -* **Success Response**
- * **Code:** `201`
- **Message:** `Profile updated`
- **data:** `{ id: "user_id", firstName, lastName, email, isAdmin }` +- **Success Response**
+ + - **Code:** `201`
+ **Message:** `Profile updated`
+ **data:** `{ id: "user_id", firstName, lastName, email, isAdmin }` + +- **Error Response** -* **Error Response** - * **Code:** `400`
- **Message:** `User Not Found`
+ - **Code:** `400`
+ **Message:** `User Not Found`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : True** +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : True** **2. User: Follow other user** -* **URL** + +- **URL** `/followUser/:user_id` -* **METHOD** +- **METHOD** `PUT` -* **PASSED OBJETCS**
- *No need to pass anything just replace :user_id with user_id which you want to update* +- **OBJECTS**
+ _No need to pass anything just replace :user_id with user_id which you want to update_ + +- **Success Response**
-* **Success Response**
- * **Code:** `201`
- **Message:** `Following`
- **data:** `{data}` + - **Code:** `201`
+ **Message:** `Following`
+ **data:** `{data}` -* **Error Response** - * **Code:** `400`
- **Message:** `Something went wrong`
+- **Error Response** -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : false** + - **Code:** `400`
+ **Message:** `Something went wrong`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : false** **3. User: Unfollow other user** -* **URL** + +- **URL** `/unfollowUser/:user_id` -* **METHOD** +- **METHOD** `PUT` -* **PASSED OBJETCS**
- *No need to pass anything just replace :user_id with user_id which you want to update* +- **OBJECTS**
+ _No need to pass anything just replace :user_id with user_id which you want to update_ -* **Success Response**
- * **Code:** `201`
- **Message:** `Unfollowing`
- **data:** `{null}` +- **Success Response**
-* **Error Response** - * **Code:** `400`
- **Message:** `Something went wrong`
+ - **Code:** `201`
+ **Message:** `Unfollowing`
+ **data:** `{null}` -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : false** +- **Error Response** + + - **Code:** `400`
+ **Message:** `Something went wrong`
+ +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : false** **4. User: Follow Space** -* **URL** + +- **URL** `/followSpace/:space_id` -* **METHOD** +- **METHOD** `PUT` -* **PASSED OBJETCS**
- *No need to pass anything just replace :space_id with space_id which you want to update* +- **OBJECTS**
+ _No need to pass anything just replace :space_id with space_id which you want to update_ + +- **Success Response**
-* **Success Response**
- * **Code:** `201`
- **Message:** `Following`
- **data:** `{data}` + - **Code:** `201`
+ **Message:** `Following`
+ **data:** `{data}` -* **Error Response** - * **Code:** `400`
- **Message:** `Something went wrong`
+- **Error Response** -* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : false** + - **Code:** `400`
+ **Message:** `Something went wrong`
+- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : false** **5. User: Unfollow Space** -* **URL** + +- **URL** `/unfollowSpace/:space_id` -* **METHOD** +- **METHOD** `PUT` -* **PASSED OBJETCS**
- *No need to pass anything just replace :space_id with space_id which you want to update* +- **OBJECTS**
+ _No need to pass anything just replace :space_id with space_id which you want to update_ + +- **Success Response**
+ + - **Code:** `201`
+ **Message:** `Unfollow`
+ **data:** `{data}` -* **Success Response**
- * **Code:** `201`
- **Message:** `Unfollow`
- **data:** `{data}` +- **Error Response** -* **Error Response** - * **Code:** `400`
- **Message:** `Something went wrong`
+ - **Code:** `400`
+ **Message:** `Something went wrong`
-* **Required Filed** - * **Auth Need : True** - * **Admin Auth Need : false** \ No newline at end of file +- **Required Filed** + - **Auth Need : True** + - **Admin Auth Need : false**